github.TeamSyncGroupMapping
Explore with Pulumi AI
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
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
import com.pulumi.github.TeamSyncGroupMapping;
import com.pulumi.github.TeamSyncGroupMappingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var exampleGroups = GithubFunctions.getOrganizationTeamSyncGroups();
var exampleGroupMapping = new TeamSyncGroupMapping("exampleGroupMapping", TeamSyncGroupMappingArgs.builder()
.teamSlug("example")
.dynamic(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
}
}
Coming soon!
Create TeamSyncGroupMapping Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TeamSyncGroupMapping(name: string, args: TeamSyncGroupMappingArgs, opts?: CustomResourceOptions);
@overload
def TeamSyncGroupMapping(resource_name: str,
args: TeamSyncGroupMappingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TeamSyncGroupMapping(resource_name: str,
opts: Optional[ResourceOptions] = None,
team_slug: Optional[str] = None,
groups: Optional[Sequence[TeamSyncGroupMappingGroupArgs]] = None)
func NewTeamSyncGroupMapping(ctx *Context, name string, args TeamSyncGroupMappingArgs, opts ...ResourceOption) (*TeamSyncGroupMapping, error)
public TeamSyncGroupMapping(string name, TeamSyncGroupMappingArgs args, CustomResourceOptions? opts = null)
public TeamSyncGroupMapping(String name, TeamSyncGroupMappingArgs args)
public TeamSyncGroupMapping(String name, TeamSyncGroupMappingArgs args, CustomResourceOptions options)
type: github:TeamSyncGroupMapping
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
- args TeamSyncGroupMappingArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args TeamSyncGroupMappingArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var teamSyncGroupMappingResource = new Github.TeamSyncGroupMapping("teamSyncGroupMappingResource", new()
{
TeamSlug = "string",
Groups = new[]
{
new Github.Inputs.TeamSyncGroupMappingGroupArgs
{
GroupDescription = "string",
GroupId = "string",
GroupName = "string",
},
},
});
example, err := github.NewTeamSyncGroupMapping(ctx, "teamSyncGroupMappingResource", &github.TeamSyncGroupMappingArgs{
TeamSlug: pulumi.String("string"),
Groups: github.TeamSyncGroupMappingGroupArray{
&github.TeamSyncGroupMappingGroupArgs{
GroupDescription: pulumi.String("string"),
GroupId: pulumi.String("string"),
GroupName: pulumi.String("string"),
},
},
})
var teamSyncGroupMappingResource = new TeamSyncGroupMapping("teamSyncGroupMappingResource", TeamSyncGroupMappingArgs.builder()
.teamSlug("string")
.groups(TeamSyncGroupMappingGroupArgs.builder()
.groupDescription("string")
.groupId("string")
.groupName("string")
.build())
.build());
team_sync_group_mapping_resource = github.TeamSyncGroupMapping("teamSyncGroupMappingResource",
team_slug="string",
groups=[github.TeamSyncGroupMappingGroupArgs(
group_description="string",
group_id="string",
group_name="string",
)])
const teamSyncGroupMappingResource = new github.TeamSyncGroupMapping("teamSyncGroupMappingResource", {
teamSlug: "string",
groups: [{
groupDescription: "string",
groupId: "string",
groupName: "string",
}],
});
type: github:TeamSyncGroupMapping
properties:
groups:
- groupDescription: string
groupId: string
groupName: string
teamSlug: string
TeamSyncGroupMapping Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The TeamSyncGroupMapping resource accepts the following input properties:
- Team
Slug string - Slug of the team
- Groups
List<Team
Sync Group Mapping Group> An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:
- Team
Slug string - Slug of the team
- Groups
[]Team
Sync Group Mapping Group Args An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:
- team
Slug String - Slug of the team
- groups
List<Team
Sync Group Mapping Group> An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:
- team
Slug string - Slug of the team
- groups
Team
Sync Group Mapping Group[] An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:
- team_
slug str - Slug of the team
- groups
Sequence[Team
Sync Group Mapping Group Args] An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:
- team
Slug String - Slug of the team
- groups List<Property Map>
An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:
Outputs
All input properties are implicitly available as output properties. Additionally, the TeamSyncGroupMapping resource produces the following output properties:
Look up 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
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
etag: Optional[str] = None,
groups: Optional[Sequence[TeamSyncGroupMappingGroupArgs]] = None,
team_slug: Optional[str] = None) -> TeamSyncGroupMapping
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)
public static TeamSyncGroupMapping get(String name, Output<String> id, TeamSyncGroupMappingState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Etag string
- Groups
List<Team
Sync Group Mapping Group> An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:- Team
Slug string - Slug of the team
- Etag string
- Groups
[]Team
Sync Group Mapping Group Args An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:- Team
Slug string - Slug of the team
- etag String
- groups
List<Team
Sync Group Mapping Group> An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:- team
Slug String - Slug of the team
- etag string
- groups
Team
Sync Group Mapping Group[] An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:- team
Slug string - Slug of the team
- etag str
- groups
Sequence[Team
Sync Group Mapping Group Args] An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:- team_
slug str - Slug of the team
- etag String
- groups List<Property Map>
An Array of GitHub Identity Provider Groups (or empty []). Each
group
block consists of the fields documented below.The
group
block consists of:- team
Slug String - Slug of the team
Supporting Types
TeamSyncGroupMappingGroup, TeamSyncGroupMappingGroupArgs
- Group
Description string - The description of the IdP group.
- Group
Id string - The ID of the IdP group.
- Group
Name string - The name of the IdP group.
- Group
Description string - The description of the IdP group.
- Group
Id string - The ID of the IdP group.
- Group
Name string - The name of the IdP group.
- group
Description String - The description of the IdP group.
- group
Id String - The ID of the IdP group.
- group
Name String - The name of the IdP group.
- group
Description string - The description of the IdP group.
- group
Id string - The ID of the IdP group.
- group
Name string - The name of the IdP group.
- group_
description str - The description of the IdP group.
- group_
id str - The ID of the IdP group.
- group_
name str - The name of the IdP group.
- group
Description String - The description of the IdP group.
- group
Id String - The ID of the IdP group.
- group
Name String - The name of the IdP group.
Import
GitHub Team Sync Group Mappings can be imported using the GitHub team slug
e.g.
$ pulumi import github:index/teamSyncGroupMapping:TeamSyncGroupMapping example some_team
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
github
Terraform Provider.