Package software.amazon.awscdk.services.sagemaker

Class CfnWorkteam

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sagemaker.CfnWorkteam
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.567Z") @Stability(Stable) public class CfnWorkteam extends CfnResource implements IInspectable
A CloudFormation AWS::SageMaker::Workteam.

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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnWorkteam

      @Stability(Stable) public CfnWorkteam(@NotNull 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 -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

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

    • 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()
      An array of key-value pairs.

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

      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) use OidcMemberDefinition .

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

      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) use OidcMemberDefinition .

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

      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) use OidcMemberDefinition .

    • getNotificationConfiguration

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

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

    • getWorkforceName

      @Stability(Stable) @Nullable public String getWorkforceName()
      AWS::SageMaker::Workteam.WorkforceName.

    • setWorkforceName

      @Stability(Stable) public void setWorkforceName(@Nullable String value)
      AWS::SageMaker::Workteam.WorkforceName.

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