Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. sagemaker
  5. Workteam

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.Workteam

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    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=[{
        "cognitoMemberDefinition": {
            "clientId": example_aws_cognito_user_pool_client["id"],
            "userPool": example_aws_cognito_user_pool_domain["userPoolId"],
            "userGroup": example_aws_cognito_user_group["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
	})
}

    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 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=[{
        "oidcMemberDefinition": {
            "groups": ["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
	})
}

    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 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

    Create Workteam Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workteam(name: string, args: WorkteamArgs, opts?: CustomResourceOptions);
    @overload
def Workteam(resource_name: str,
             args: WorkteamArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Workteam(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             description: Optional[str] = None,
             member_definitions: Optional[Sequence[WorkteamMemberDefinitionArgs]] = None,
             workforce_name: Optional[str] = None,
             workteam_name: Optional[str] = None,
             notification_configuration: Optional[WorkteamNotificationConfigurationArgs] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewWorkteam(ctx *Context, name string, args WorkteamArgs, opts ...ResourceOption) (*Workteam, error)
    public Workteam(string name, WorkteamArgs args, CustomResourceOptions? opts = null)
    public Workteam(String name, WorkteamArgs args)
public Workteam(String name, WorkteamArgs args, CustomResourceOptions options)

    type: aws:sagemaker:Workteam
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 WorkteamArgs
    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 WorkteamArgs
    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 WorkteamArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkteamArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkteamArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workteamResource = new Aws.Sagemaker.Workteam("workteamResource", new()
{
    Description = "string",
    MemberDefinitions = new[]
    {
        new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionArgs
        {
            CognitoMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionCognitoMemberDefinitionArgs
            {
                ClientId = "string",
                UserGroup = "string",
                UserPool = "string",
            },
            OidcMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionOidcMemberDefinitionArgs
            {
                Groups = new[]
                {
                    "string",
                },
            },
        },
    },
    WorkforceName = "string",
    WorkteamName = "string",
    NotificationConfiguration = new Aws.Sagemaker.Inputs.WorkteamNotificationConfigurationArgs
    {
        NotificationTopicArn = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := sagemaker.NewWorkteam(ctx, "workteamResource", &sagemaker.WorkteamArgs{
	Description: pulumi.String("string"),
	MemberDefinitions: sagemaker.WorkteamMemberDefinitionArray{
		&sagemaker.WorkteamMemberDefinitionArgs{
			CognitoMemberDefinition: &sagemaker.WorkteamMemberDefinitionCognitoMemberDefinitionArgs{
				ClientId:  pulumi.String("string"),
				UserGroup: pulumi.String("string"),
				UserPool:  pulumi.String("string"),
			},
			OidcMemberDefinition: &sagemaker.WorkteamMemberDefinitionOidcMemberDefinitionArgs{
				Groups: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	WorkforceName: pulumi.String("string"),
	WorkteamName:  pulumi.String("string"),
	NotificationConfiguration: &sagemaker.WorkteamNotificationConfigurationArgs{
		NotificationTopicArn: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var workteamResource = new Workteam("workteamResource", WorkteamArgs.builder()
    .description("string")
    .memberDefinitions(WorkteamMemberDefinitionArgs.builder()
        .cognitoMemberDefinition(WorkteamMemberDefinitionCognitoMemberDefinitionArgs.builder()
            .clientId("string")
            .userGroup("string")
            .userPool("string")
            .build())
        .oidcMemberDefinition(WorkteamMemberDefinitionOidcMemberDefinitionArgs.builder()
            .groups("string")
            .build())
        .build())
    .workforceName("string")
    .workteamName("string")
    .notificationConfiguration(WorkteamNotificationConfigurationArgs.builder()
        .notificationTopicArn("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    workteam_resource = aws.sagemaker.Workteam("workteamResource",
    description="string",
    member_definitions=[{
        "cognitoMemberDefinition": {
            "clientId": "string",
            "userGroup": "string",
            "userPool": "string",
        },
        "oidcMemberDefinition": {
            "groups": ["string"],
        },
    }],
    workforce_name="string",
    workteam_name="string",
    notification_configuration={
        "notificationTopicArn": "string",
    },
    tags={
        "string": "string",
    })

    const workteamResource = new aws.sagemaker.Workteam("workteamResource", {
    description: "string",
    memberDefinitions: [{
        cognitoMemberDefinition: {
            clientId: "string",
            userGroup: "string",
            userPool: "string",
        },
        oidcMemberDefinition: {
            groups: ["string"],
        },
    }],
    workforceName: "string",
    workteamName: "string",
    notificationConfiguration: {
        notificationTopicArn: "string",
    },
    tags: {
        string: "string",
    },
});

    type: aws:sagemaker:Workteam
properties:
    description: string
    memberDefinitions:
        - cognitoMemberDefinition:
            clientId: string
            userGroup: string
            userPool: string
          oidcMemberDefinition:
            groups:
                - string
    notificationConfiguration:
        notificationTopicArn: string
    tags:
        string: string
    workforceName: string
    workteamName: string

    Workteam 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 Workteam resource accepts the following input properties:

    Description string
    A description of the work team.
    MemberDefinitions List<Pulumi.Aws.Sagemaker.Inputs.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.
    WorkforceName string
    The name of the Workteam (must be unique).
    WorkteamName string
    The name of the workforce.
    NotificationConfiguration Pulumi.Aws.Sagemaker.Inputs.WorkteamNotificationConfiguration
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    Tags Dictionary<string, string>
    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.
    Description string
    A description of the work team.
    MemberDefinitions []WorkteamMemberDefinitionArgs
    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.
    WorkforceName string
    The name of the Workteam (must be unique).
    WorkteamName string
    The name of the workforce.
    NotificationConfiguration WorkteamNotificationConfigurationArgs
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    Tags map[string]string
    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.
    description String
    A description of the work team.
    memberDefinitions 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.
    workforceName String
    The name of the Workteam (must be unique).
    workteamName String
    The name of the workforce.
    notificationConfiguration WorkteamNotificationConfiguration
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    tags Map<String,String>
    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.
    description string
    A description of the work team.
    memberDefinitions 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.
    workforceName string
    The name of the Workteam (must be unique).
    workteamName string
    The name of the workforce.
    notificationConfiguration WorkteamNotificationConfiguration
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    tags {[key: string]: string}
    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.
    description str
    A description of the work team.
    member_definitions Sequence[WorkteamMemberDefinitionArgs]
    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.
    workforce_name str
    The name of the Workteam (must be unique).
    workteam_name str
    The name of the workforce.
    notification_configuration WorkteamNotificationConfigurationArgs
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    tags Mapping[str, str]
    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.
    description String
    A description of the work team.
    memberDefinitions List<Property Map>
    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.
    workforceName String
    The name of the Workteam (must be unique).
    workteamName String
    The name of the workforce.
    notificationConfiguration Property Map
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    tags Map<String>
    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.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    Id string
    The provider-assigned unique ID for this managed resource.
    Subdomain string
    The subdomain for your OIDC Identity Provider.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    Id string
    The provider-assigned unique ID for this managed resource.
    Subdomain string
    The subdomain for your OIDC Identity Provider.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    id String
    The provider-assigned unique ID for this managed resource.
    subdomain String
    The subdomain for your OIDC Identity Provider.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    id string
    The provider-assigned unique ID for this managed resource.
    subdomain string
    The subdomain for your OIDC Identity Provider.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    id str
    The provider-assigned unique ID for this managed resource.
    subdomain str
    The subdomain for your OIDC Identity Provider.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    id String
    The provider-assigned unique ID for this managed resource.
    subdomain String
    The subdomain for your OIDC Identity Provider.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Workteam Resource

    Get an existing Workteam 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?: WorkteamState, opts?: CustomResourceOptions): Workteam
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        member_definitions: Optional[Sequence[WorkteamMemberDefinitionArgs]] = None,
        notification_configuration: Optional[WorkteamNotificationConfigurationArgs] = None,
        subdomain: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        workforce_name: Optional[str] = None,
        workteam_name: Optional[str] = None) -> Workteam
    func GetWorkteam(ctx *Context, name string, id IDInput, state *WorkteamState, opts ...ResourceOption) (*Workteam, error)
    public static Workteam Get(string name, Input<string> id, WorkteamState? state, CustomResourceOptions? opts = null)
    public static Workteam get(String name, Output<String> id, WorkteamState 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.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    Description string
    A description of the work team.
    MemberDefinitions List<Pulumi.Aws.Sagemaker.Inputs.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 Pulumi.Aws.Sagemaker.Inputs.WorkteamNotificationConfiguration
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    Subdomain string
    The subdomain for your OIDC Identity Provider.
    Tags Dictionary<string, string>
    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    WorkforceName string
    The name of the Workteam (must be unique).
    WorkteamName string
    The name of the workforce.
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    Description string
    A description of the work team.
    MemberDefinitions []WorkteamMemberDefinitionArgs
    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 WorkteamNotificationConfigurationArgs
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    Subdomain string
    The subdomain for your OIDC Identity Provider.
    Tags map[string]string
    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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    WorkforceName string
    The name of the Workteam (must be unique).
    WorkteamName string
    The name of the workforce.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    description String
    A description of the work team.
    memberDefinitions 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 WorkteamNotificationConfiguration
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    subdomain String
    The subdomain for your OIDC Identity Provider.
    tags Map<String,String>
    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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workforceName String
    The name of the Workteam (must be unique).
    workteamName String
    The name of the workforce.
    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    description string
    A description of the work team.
    memberDefinitions 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 WorkteamNotificationConfiguration
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    subdomain string
    The subdomain for your OIDC Identity Provider.
    tags {[key: string]: string}
    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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workforceName string
    The name of the Workteam (must be unique).
    workteamName string
    The name of the workforce.
    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    description str
    A description of the work team.
    member_definitions Sequence[WorkteamMemberDefinitionArgs]
    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.
    notification_configuration WorkteamNotificationConfigurationArgs
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    subdomain str
    The subdomain for your OIDC Identity Provider.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workforce_name str
    The name of the Workteam (must be unique).
    workteam_name str
    The name of the workforce.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
    description String
    A description of the work team.
    memberDefinitions List<Property Map>
    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 Property Map
    Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
    subdomain String
    The subdomain for your OIDC Identity Provider.
    tags Map<String>
    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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    workforceName String
    The name of the Workteam (must be unique).
    workteamName String
    The name of the workforce.

    Supporting Types

    WorkteamMemberDefinition, WorkteamMemberDefinitionArgs

    CognitoMemberDefinition Pulumi.Aws.Sagemaker.Inputs.WorkteamMemberDefinitionCognitoMemberDefinition
    The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
    OidcMemberDefinition Pulumi.Aws.Sagemaker.Inputs.WorkteamMemberDefinitionOidcMemberDefinition
    A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. See Cognito Member Definition details below.
    CognitoMemberDefinition WorkteamMemberDefinitionCognitoMemberDefinition
    The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
    OidcMemberDefinition WorkteamMemberDefinitionOidcMemberDefinition
    A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. See Cognito Member Definition details below.
    cognitoMemberDefinition WorkteamMemberDefinitionCognitoMemberDefinition
    The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
    oidcMemberDefinition WorkteamMemberDefinitionOidcMemberDefinition
    A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. See Cognito Member Definition details below.
    cognitoMemberDefinition WorkteamMemberDefinitionCognitoMemberDefinition
    The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
    oidcMemberDefinition WorkteamMemberDefinitionOidcMemberDefinition
    A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. See Cognito Member Definition details below.
    cognito_member_definition WorkteamMemberDefinitionCognitoMemberDefinition
    The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
    oidc_member_definition WorkteamMemberDefinitionOidcMemberDefinition
    A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. See Cognito Member Definition details below.
    cognitoMemberDefinition Property Map
    The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
    oidcMemberDefinition Property Map
    A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. See Cognito Member Definition details below.

    WorkteamMemberDefinitionCognitoMemberDefinition, WorkteamMemberDefinitionCognitoMemberDefinitionArgs

    ClientId string
    An identifier for an application client. You must create the app client ID using Amazon Cognito.
    UserGroup string
    An identifier for a user group.
    UserPool string
    An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
    ClientId string
    An identifier for an application client. You must create the app client ID using Amazon Cognito.
    UserGroup string
    An identifier for a user group.
    UserPool string
    An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
    clientId String
    An identifier for an application client. You must create the app client ID using Amazon Cognito.
    userGroup String
    An identifier for a user group.
    userPool String
    An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
    clientId string
    An identifier for an application client. You must create the app client ID using Amazon Cognito.
    userGroup string
    An identifier for a user group.
    userPool string
    An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
    client_id str
    An identifier for an application client. You must create the app client ID using Amazon Cognito.
    user_group str
    An identifier for a user group.
    user_pool str
    An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
    clientId String
    An identifier for an application client. You must create the app client ID using Amazon Cognito.
    userGroup String
    An identifier for a user group.
    userPool String
    An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

    WorkteamMemberDefinitionOidcMemberDefinition, WorkteamMemberDefinitionOidcMemberDefinitionArgs

    Groups List<string>
    A list of comma separated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
    Groups []string
    A list of comma separated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
    groups List<String>
    A list of comma separated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
    groups string[]
    A list of comma separated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
    groups Sequence[str]
    A list of comma separated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
    groups List<String>
    A list of comma separated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

    WorkteamNotificationConfiguration, WorkteamNotificationConfigurationArgs

    NotificationTopicArn string
    The ARN for the SNS topic to which notifications should be published.
    NotificationTopicArn string
    The ARN for the SNS topic to which notifications should be published.
    notificationTopicArn String
    The ARN for the SNS topic to which notifications should be published.
    notificationTopicArn string
    The ARN for the SNS topic to which notifications should be published.
    notification_topic_arn str
    The ARN for the SNS topic to which notifications should be published.
    notificationTopicArn String
    The ARN for the SNS topic to which notifications should be published.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws