Package software.amazon.awscdk.services.sagemaker

Class CfnWorkteam

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnWorkteam
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWorkteamRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:29.378Z") @Stability(Stable) public class CfnWorkteam extends CfnResource implements IInspectable, IWorkteamRef, ITaggable
Creates a new work team for labeling your data.

A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnWorkteam cfnWorkteam = CfnWorkteam.Builder.create(this, "MyCfnWorkteam")
         .description("description")
         .memberDefinitions(List.of(MemberDefinitionProperty.builder()
                 .cognitoMemberDefinition(CognitoMemberDefinitionProperty.builder()
                         .cognitoClientId("cognitoClientId")
                         .cognitoUserGroup("cognitoUserGroup")
                         .cognitoUserPool("cognitoUserPool")
                         .build())
                 .oidcMemberDefinition(OidcMemberDefinitionProperty.builder()
                         .oidcGroups(List.of("oidcGroups"))
                         .build())
                 .build()))
         .notificationConfiguration(NotificationConfigurationProperty.builder()
                 .notificationTopicArn("notificationTopicArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workforceName("workforceName")
         .workteamName("workteamName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkteam

      protected CfnWorkteam(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkteam

      protected CfnWorkteam(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkteam

      @Stability(Stable) public CfnWorkteam(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnWorkteamProps props)
      Create a new AWS::SageMaker::Workteam.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnWorkteam

      @Stability(Stable) public CfnWorkteam(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::SageMaker::Workteam.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForWorkteam

      @Stability(Stable) @NotNull public static String arnForWorkteam(@NotNull IWorkteamRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnWorkteam

      @Stability(Stable) @NotNull public static Boolean isCfnWorkteam(@NotNull Object x)
      Checks whether the given object is a CfnWorkteam.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getAttrWorkteamName

      @Stability(Stable) @NotNull public String getAttrWorkteamName()
      The name of the work team.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getWorkteamRef

      @Stability(Stable) @NotNull public WorkteamReference getWorkteamRef()
      A reference to a Workteam resource.
      Specified by:
      getWorkteamRef in interface IWorkteamRef

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the work team.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the work team.

    • getMemberDefinitions

      @Stability(Stable) @Nullable public Object getMemberDefinitions()
      A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkteam.MemberDefinitionProperty>

    • setMemberDefinitions

      @Stability(Stable) public void setMemberDefinitions(@Nullable IResolvable value)
      A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

    • setMemberDefinitions

      @Stability(Stable) public void setMemberDefinitions(@Nullable List<Object> value)
      A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

    • getNotificationConfiguration

      @Stability(Stable) @Nullable public Object getNotificationConfiguration()
      Configures SNS notifications of available or expiring work items for work teams.

      Returns union: either IResolvable or CfnWorkteam.NotificationConfigurationProperty

    • setNotificationConfiguration

      @Stability(Stable) public void setNotificationConfiguration(@Nullable IResolvable value)
      Configures SNS notifications of available or expiring work items for work teams.

    • setNotificationConfiguration

      @Stability(Stable) public void setNotificationConfiguration(@Nullable CfnWorkteam.NotificationConfigurationProperty value)
      Configures SNS notifications of available or expiring work items for work teams.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs.

    • getWorkforceName

      @Stability(Stable) @Nullable public String getWorkforceName()
      The name of the workforce.

    • setWorkforceName

      @Stability(Stable) public void setWorkforceName(@Nullable String value)
      The name of the workforce.

    • getWorkteamName

      @Stability(Stable) @Nullable public String getWorkteamName()
      The name of the work team.

    • setWorkteamName

      @Stability(Stable) public void setWorkteamName(@Nullable String value)
      The name of the work team.