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

WorkteamArgs

data class WorkteamArgs(val description: Output<String>? = null, val memberDefinitions: Output<List<WorkteamMemberDefinitionArgs>>? = null, val notificationConfiguration: Output<WorkteamNotificationConfigurationArgs>? = null, val tags: Output<Map<String, String>>? = null, val workerAccessConfiguration: Output<WorkteamWorkerAccessConfigurationArgs>? = null, val workforceName: Output<String>? = null, val workteamName: Output<String>? = null) : ConvertibleToJava<WorkteamArgs>

Provides a SageMaker AI 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.name,
        },
    }],
});
Content copied to clipboard
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=[{
        "cognito_member_definition": {
            "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["name"],
        },
    }])
Content copied to clipboard
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.Name,
                },
            },
        },
    });
});
Content copied to clipboard
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.Name),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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.name())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:sagemaker:Workteam
    properties:
      workteamName: example
      workforceName: ${exampleAwsSagemakerWorkforce.id}
      description: example
      memberDefinitions:
        - cognitoMemberDefinition:
            clientId: ${exampleAwsCognitoUserPoolClient.id}
            userPool: ${exampleAwsCognitoUserPoolDomain.userPoolId}
            userGroup: ${exampleAwsCognitoUserGroup.name}
Content copied to clipboard

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"],
        },
    }],
});
Content copied to clipboard
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=[{
        "oidc_member_definition": {
            "groups": ["example"],
        },
    }])
Content copied to clipboard
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",
                    },
                },
            },
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:sagemaker:Workteam
    properties:
      workteamName: example
      workforceName: ${exampleAwsSagemakerWorkforce.id}
      description: example
      memberDefinitions:
        - oidcMemberDefinition:
            groups:
              - example
Content copied to clipboard

Import

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

$ pulumi import aws:sagemaker/workteam:Workteam example example
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, memberDefinitions: Output<List<WorkteamMemberDefinitionArgs>>? = null, notificationConfiguration: Output<WorkteamNotificationConfigurationArgs>? = null, tags: Output<Map<String, String>>? = null, workerAccessConfiguration: Output<WorkteamWorkerAccessConfigurationArgs>? = null, workforceName: Output<String>? = null, workteamName: Output<String>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

A description of the work team.

Link copied to clipboard
val memberDefinitions: Output<List<WorkteamMemberDefinitionArgs>>? = null

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.

Link copied to clipboard
val notificationConfiguration: Output<WorkteamNotificationConfigurationArgs>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val workerAccessConfiguration: Output<WorkteamWorkerAccessConfigurationArgs>? = null

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.

Link copied to clipboard
val workforceName: Output<String>? = null

The name of the workforce.

Link copied to clipboard
val workteamName: Output<String>? = null

The name of the Workteam (must be unique).

Functions

Link copied to clipboard
open override fun toJava(): WorkteamArgs