TeamSyncGroupMapping

This resource allows you to create and manage Identity Provider (IdP) group connections within your GitHub teams. You must have team synchronization enabled for organizations owned by enterprise accounts.

To learn more about team synchronization between IdPs and Github, please refer to: https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/synchronizing-teams-between-your-identity-provider-and-github

Create a TeamSyncGroupMapping Resource

new TeamSyncGroupMapping(name: string, args: TeamSyncGroupMappingArgs, opts?: CustomResourceOptions);

def TeamSyncGroupMapping(resource_name, opts=None, groups=None, team_slug=None, __props__=None);

func NewTeamSyncGroupMapping(ctx *Context, name string, args TeamSyncGroupMappingArgs, opts ...ResourceOption) (*TeamSyncGroupMapping, error)

public TeamSyncGroupMapping(string name, TeamSyncGroupMappingArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args TeamSyncGroupMappingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TeamSyncGroupMappingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TeamSyncGroupMappingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

TeamSyncGroupMapping Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The TeamSyncGroupMapping resource accepts the following input properties:

TeamSlug string: Slug of the team
Groups List<TeamSyncGroupMappingGroupArgs>: An Array of GitHub Identity Provider Groups (or empty []). Each group block consists of the fields documented below.

TeamSlug string: Slug of the team
Groups []TeamSyncGroupMappingGroup: An Array of GitHub Identity Provider Groups (or empty []). Each group block consists of the fields documented below.

teamSlug string: Slug of the team
groups TeamSyncGroupMappingGroup[]: An Array of GitHub Identity Provider Groups (or empty []). Each group block consists of the fields documented below.

team_slug str: Slug of the team
groups List[TeamSyncGroupMappingGroup]: An Array of GitHub Identity Provider Groups (or empty []). Each group block consists of the fields documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the TeamSyncGroupMapping resource produces the following output properties:

Etag string
Id string: The provider-assigned unique ID for this managed resource.

Etag string
Id string: The provider-assigned unique ID for this managed resource.

etag string
id string: The provider-assigned unique ID for this managed resource.

etag str
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing TeamSyncGroupMapping Resource

Get an existing TeamSyncGroupMapping resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TeamSyncGroupMappingState, opts?: CustomResourceOptions): TeamSyncGroupMapping

static get(resource_name, id, opts=None, etag=None, groups=None, team_slug=None, __props__=None);

func GetTeamSyncGroupMapping(ctx *Context, name string, id IDInput, state *TeamSyncGroupMappingState, opts ...ResourceOption) (*TeamSyncGroupMapping, error)

public static TeamSyncGroupMapping Get(string name, Input<string> id, TeamSyncGroupMappingState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Etag string
Groups List<TeamSyncGroupMappingGroupArgs>: An Array of GitHub Identity Provider Groups (or empty []). Each group block consists of the fields documented below.
TeamSlug string: Slug of the team

Etag string
Groups []TeamSyncGroupMappingGroup: An Array of GitHub Identity Provider Groups (or empty []). Each group block consists of the fields documented below.
TeamSlug string: Slug of the team

etag string
groups TeamSyncGroupMappingGroup[]: An Array of GitHub Identity Provider Groups (or empty []). Each group block consists of the fields documented below.
teamSlug string: Slug of the team

etag str
groups List[TeamSyncGroupMappingGroup]: An Array of GitHub Identity Provider Groups (or empty []). Each group block consists of the fields documented below.
team_slug str: Slug of the team

Supporting Types

TeamSyncGroupMappingGroup

See the input and output API doc for this type.

GroupDescription string: The description of the IdP group.
GroupId string: The ID of the IdP group.
GroupName string: The name of the IdP group.

GroupDescription string: The description of the IdP group.
GroupId string: The ID of the IdP group.
GroupName string: The name of the IdP group.

groupDescription string: The description of the IdP group.
groupId string: The ID of the IdP group.
groupName string: The name of the IdP group.

groupDescription str: The description of the IdP group.
groupId str: The ID of the IdP group.
groupName str: The name of the IdP group.

Package Details

Repository: https://github.com/pulumi/pulumi-github
License: Apache-2.0
Notes: This Pulumi package is based on the github Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud