Workteam class
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", {
memberDefinitions: [{
cognitoMemberDefinition: {
clientId: exampleAwsCognitoUserPoolClient.id,
userPool: exampleAwsCognitoUserPoolDomain.userPoolId,
userGroup: exampleAwsCognitoUserGroup.name,
},
}],
workteamName: "example",
workforceName: exampleAwsSagemakerWorkforce.id,
description: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.Workteam("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"],
},
}],
workteam_name="example",
workforce_name=example_aws_sagemaker_workforce["id"],
description="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()
{
MemberDefinitions = new[]
{
new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionArgs
{
CognitoMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionCognitoMemberDefinitionArgs
{
ClientId = exampleAwsCognitoUserPoolClient.Id,
UserPool = exampleAwsCognitoUserPoolDomain.UserPoolId,
UserGroup = exampleAwsCognitoUserGroup.Name,
},
},
},
WorkteamName = "example",
WorkforceName = exampleAwsSagemakerWorkforce.Id,
Description = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
MemberDefinitions: sagemaker.WorkteamMemberDefinitionArray{
&sagemaker.WorkteamMemberDefinitionArgs{
CognitoMemberDefinition: &sagemaker.WorkteamMemberDefinitionCognitoMemberDefinitionArgs{
ClientId: pulumi.Any(exampleAwsCognitoUserPoolClient.Id),
UserPool: pulumi.Any(exampleAwsCognitoUserPoolDomain.UserPoolId),
UserGroup: pulumi.Any(exampleAwsCognitoUserGroup.Name),
},
},
},
WorkteamName: pulumi.String("example"),
WorkforceName: pulumi.Any(exampleAwsSagemakerWorkforce.Id),
Description: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sagemaker_workteam" "example" {
member_definitions {
cognito_member_definition = {
client_id = exampleAwsCognitoUserPoolClient.id
user_pool = exampleAwsCognitoUserPoolDomain.userPoolId
user_group = exampleAwsCognitoUserGroup.name
}
}
workteam_name = "example"
workforce_name = exampleAwsSagemakerWorkforce.id
description = "example"
}
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.ArrayList;
import java.util.Arrays;
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()
.memberDefinitions(WorkteamMemberDefinitionArgs.builder()
.cognitoMemberDefinition(WorkteamMemberDefinitionCognitoMemberDefinitionArgs.builder()
.clientId(exampleAwsCognitoUserPoolClient.id())
.userPool(exampleAwsCognitoUserPoolDomain.userPoolId())
.userGroup(exampleAwsCognitoUserGroup.name())
.build())
.build())
.workteamName("example")
.workforceName(exampleAwsSagemakerWorkforce.id())
.description("example")
.build());
}
}
resources:
example:
type: aws:sagemaker:Workteam
properties:
memberDefinitions:
- cognitoMemberDefinition:
clientId: ${exampleAwsCognitoUserPoolClient.id}
userPool: ${exampleAwsCognitoUserPoolDomain.userPoolId}
userGroup: ${exampleAwsCognitoUserGroup.name}
workteamName: example
workforceName: ${exampleAwsSagemakerWorkforce.id}
description: example
Oidc Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.Workteam("example", {
memberDefinitions: [{
oidcMemberDefinition: {
groups: ["example"],
},
}],
workteamName: "example",
workforceName: exampleAwsSagemakerWorkforce.id,
description: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.Workteam("example",
member_definitions=[{
"oidc_member_definition": {
"groups": ["example"],
},
}],
workteam_name="example",
workforce_name=example_aws_sagemaker_workforce["id"],
description="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()
{
MemberDefinitions = new[]
{
new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionArgs
{
OidcMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionOidcMemberDefinitionArgs
{
Groups = new[]
{
"example",
},
},
},
},
WorkteamName = "example",
WorkforceName = exampleAwsSagemakerWorkforce.Id,
Description = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
MemberDefinitions: sagemaker.WorkteamMemberDefinitionArray{
&sagemaker.WorkteamMemberDefinitionArgs{
OidcMemberDefinition: &sagemaker.WorkteamMemberDefinitionOidcMemberDefinitionArgs{
Groups: pulumi.StringArray{
pulumi.String("example"),
},
},
},
},
WorkteamName: pulumi.String("example"),
WorkforceName: pulumi.Any(exampleAwsSagemakerWorkforce.Id),
Description: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sagemaker_workteam" "example" {
member_definitions {
oidc_member_definition = {
groups = ["example"]
}
}
workteam_name = "example"
workforce_name = exampleAwsSagemakerWorkforce.id
description = "example"
}
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.ArrayList;
import java.util.Arrays;
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()
.memberDefinitions(WorkteamMemberDefinitionArgs.builder()
.oidcMemberDefinition(WorkteamMemberDefinitionOidcMemberDefinitionArgs.builder()
.groups("example")
.build())
.build())
.workteamName("example")
.workforceName(exampleAwsSagemakerWorkforce.id())
.description("example")
.build());
}
}
resources:
example:
type: aws:sagemaker:Workteam
properties:
memberDefinitions:
- oidcMemberDefinition:
groups:
- example
workteamName: example
workforceName: ${exampleAwsSagemakerWorkforce.id}
description: example
Import
Using pulumi import, import SageMaker AI Workteams using the workteamName. For example:
$ pulumi import aws:sagemaker/workteam:Workteam example example
Constructors
- Workteam(String name, {WorkteamArgs? args, CustomResourceOptions? options})
-
Creates a new Workteam.
nameThe Pulumi resource name.argsArguments used to configure this Workteam. The set of arguments for Workteam.optionsResource options controlling this resource's behavior. - Workteam.reference(String urn)
- Creates a typed reference to an existing Workteam resource.
Properties
-
arn
↔ Output<
String> -
ARN assigned by AWS to this Workteam.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
A description of the work team.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
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
cognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) useoidcMemberDefinition. Do not provide input for both of these parameters in a single request. see Member Definition details below.latefinal -
notificationConfiguration
↔ Output<
WorkteamNotificationConfiguration?> -
Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subdomain
↔ Output<
String> -
The subdomain for your OIDC Identity Provider.
latefinal
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
workerAccessConfiguration
↔ Output<
WorkteamWorkerAccessConfiguration> -
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.
latefinal
-
workforceName
↔ Output<
String?> -
The name of the workforce.
latefinal
-
workteamName
↔ Output<
String> -
The name of the Workteam (must be unique).
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited