pulumi-aws-kotlin/com.pulumi.aws.sagemaker.kotlin/Workteam

Workteam

class Workteam : KotlinCustomResource

Provides a SageMaker Workteam resource.

Example Usage

Cognito Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.Workteam("example", {
    workteamName: "example",
    workforceName: exampleAwsSagemakerWorkforce.id,
    description: "example",
    memberDefinitions: [{
        cognitoMemberDefinition: {
            clientId: exampleAwsCognitoUserPoolClient.id,
            userPool: exampleAwsCognitoUserPoolDomain.userPoolId,
            userGroup: exampleAwsCognitoUserGroup.id,
        },
    }],
});

import pulumi
import pulumi_aws as aws
example = aws.sagemaker.Workteam("example",
    workteam_name="example",
    workforce_name=example_aws_sagemaker_workforce["id"],
    description="example",
    member_definitions=[aws.sagemaker.WorkteamMemberDefinitionArgs(
        cognito_member_definition=aws.sagemaker.WorkteamMemberDefinitionCognitoMemberDefinitionArgs(
            client_id=example_aws_cognito_user_pool_client["id"],
            user_pool=example_aws_cognito_user_pool_domain["userPoolId"],
            user_group=example_aws_cognito_user_group["id"],
        ),
    )])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.Sagemaker.Workteam("example", new()
    {
        WorkteamName = "example",
        WorkforceName = exampleAwsSagemakerWorkforce.Id,
        Description = "example",
        MemberDefinitions = new[]
        {
            new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionArgs
            {
                CognitoMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionCognitoMemberDefinitionArgs
                {
                    ClientId = exampleAwsCognitoUserPoolClient.Id,
                    UserPool = exampleAwsCognitoUserPoolDomain.UserPoolId,
                    UserGroup = exampleAwsCognitoUserGroup.Id,
                },
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewWorkteam(ctx, "example", &sagemaker.WorkteamArgs{
			WorkteamName:  pulumi.String("example"),
			WorkforceName: pulumi.Any(exampleAwsSagemakerWorkforce.Id),
			Description:   pulumi.String("example"),
			MemberDefinitions: sagemaker.WorkteamMemberDefinitionArray{
				&sagemaker.WorkteamMemberDefinitionArgs{
					CognitoMemberDefinition: &sagemaker.WorkteamMemberDefinitionCognitoMemberDefinitionArgs{
						ClientId:  pulumi.Any(exampleAwsCognitoUserPoolClient.Id),
						UserPool:  pulumi.Any(exampleAwsCognitoUserPoolDomain.UserPoolId),
						UserGroup: pulumi.Any(exampleAwsCognitoUserGroup.Id),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Workteam;
import com.pulumi.aws.sagemaker.WorkteamArgs;
import com.pulumi.aws.sagemaker.inputs.WorkteamMemberDefinitionArgs;
import com.pulumi.aws.sagemaker.inputs.WorkteamMemberDefinitionCognitoMemberDefinitionArgs;
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) {
        var example = new Workteam("example", WorkteamArgs.builder()
            .workteamName("example")
            .workforceName(exampleAwsSagemakerWorkforce.id())
            .description("example")
            .memberDefinitions(WorkteamMemberDefinitionArgs.builder()
                .cognitoMemberDefinition(WorkteamMemberDefinitionCognitoMemberDefinitionArgs.builder()
                    .clientId(exampleAwsCognitoUserPoolClient.id())
                    .userPool(exampleAwsCognitoUserPoolDomain.userPoolId())
                    .userGroup(exampleAwsCognitoUserGroup.id())
                    .build())
                .build())
            .build());
    }
}

resources:
  example:
    type: aws:sagemaker:Workteam
    properties:
      workteamName: example
      workforceName: ${exampleAwsSagemakerWorkforce.id}
      description: example
      memberDefinitions:
        - cognitoMemberDefinition:
            clientId: ${exampleAwsCognitoUserPoolClient.id}
            userPool: ${exampleAwsCognitoUserPoolDomain.userPoolId}
            userGroup: ${exampleAwsCognitoUserGroup.id}

Oidc Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.Workteam("example", {
    workteamName: "example",
    workforceName: exampleAwsSagemakerWorkforce.id,
    description: "example",
    memberDefinitions: [{
        oidcMemberDefinition: {
            groups: ["example"],
        },
    }],
});

import pulumi
import pulumi_aws as aws
example = aws.sagemaker.Workteam("example",
    workteam_name="example",
    workforce_name=example_aws_sagemaker_workforce["id"],
    description="example",
    member_definitions=[aws.sagemaker.WorkteamMemberDefinitionArgs(
        oidc_member_definition=aws.sagemaker.WorkteamMemberDefinitionOidcMemberDefinitionArgs(
            groups=["example"],
        ),
    )])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.Sagemaker.Workteam("example", new()
    {
        WorkteamName = "example",
        WorkforceName = exampleAwsSagemakerWorkforce.Id,
        Description = "example",
        MemberDefinitions = new[]
        {
            new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionArgs
            {
                OidcMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionOidcMemberDefinitionArgs
                {
                    Groups = new[]
                    {
                        "example",
                    },
                },
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewWorkteam(ctx, "example", &sagemaker.WorkteamArgs{
			WorkteamName:  pulumi.String("example"),
			WorkforceName: pulumi.Any(exampleAwsSagemakerWorkforce.Id),
			Description:   pulumi.String("example"),
			MemberDefinitions: sagemaker.WorkteamMemberDefinitionArray{
				&sagemaker.WorkteamMemberDefinitionArgs{
					OidcMemberDefinition: &sagemaker.WorkteamMemberDefinitionOidcMemberDefinitionArgs{
						Groups: pulumi.StringArray{
							pulumi.String("example"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Workteam;
import com.pulumi.aws.sagemaker.WorkteamArgs;
import com.pulumi.aws.sagemaker.inputs.WorkteamMemberDefinitionArgs;
import com.pulumi.aws.sagemaker.inputs.WorkteamMemberDefinitionOidcMemberDefinitionArgs;
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) {
        var example = new Workteam("example", WorkteamArgs.builder()
            .workteamName("example")
            .workforceName(exampleAwsSagemakerWorkforce.id())
            .description("example")
            .memberDefinitions(WorkteamMemberDefinitionArgs.builder()
                .oidcMemberDefinition(WorkteamMemberDefinitionOidcMemberDefinitionArgs.builder()
                    .groups("example")
                    .build())
                .build())
            .build());
    }
}

resources:
  example:
    type: aws:sagemaker:Workteam
    properties:
      workteamName: example
      workforceName: ${exampleAwsSagemakerWorkforce.id}
      description: example
      memberDefinitions:
        - oidcMemberDefinition:
            groups:
              - example

Import

Using pulumi import, import SageMaker Workteams using the workteam_name. For example:

$ pulumi import aws:sagemaker/workteam:Workteam example example

Properties

arn

val arn: Output<String>

The Amazon Resource Name (ARN) assigned by AWS to this Workteam.

description

val description: Output<String>

A description of the work team.

val id: Output<String>

memberDefinitions

val memberDefinitions: Output<List<WorkteamMemberDefinition>>

A list of Member Definitions that contains objects that identify the workers that make up the work team. Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use cognito_member_definition. For workforces created using your own OIDC identity provider (IdP) use oidc_member_definition. Do not provide input for both of these parameters in a single request. see Member Definition details below.

notificationConfiguration

val notificationConfiguration: Output<WorkteamNotificationConfiguration>?

Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

subdomain

val subdomain: Output<String>

The subdomain for your OIDC Identity Provider.