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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.959Z")
 @Stability(value=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())
                 .build()))
         .notificationConfiguration(NotificationConfigurationProperty.builder()
                 .notificationTopicArn("notificationTopicArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workteamName("workteamName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWorkteam.Builder A fluent builder for CfnWorkteam.
static interface	CfnWorkteam.CognitoMemberDefinitionProperty Identifies a Amazon Cognito user group.
static interface	CfnWorkteam.MemberDefinitionProperty Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
static interface	CfnWorkteam.NotificationConfigurationProperty Configures Amazon SNS notifications of available or expiring work items for work teams.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWorkteam(software.constructs.Construct scope, String id) Create a new `AWS::SageMaker::Workteam`.
	CfnWorkteam(software.constructs.Construct scope, String id, CfnWorkteamProps props) Create a new `AWS::SageMaker::Workteam`.
protected	CfnWorkteam(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkteam(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrWorkteamName() The name of the work team.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the work team.
Object	getMemberDefinitions() A list of `MemberDefinition` objects that contains objects that identify the workers that make up the work team.
Object	getNotificationConfiguration() Configures SNS notifications of available or expiring work items for work teams.
TagManager	getTags() An array of key-value pairs.
String	getWorkteamName() The name of the work team.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description of the work team.
void	setMemberDefinitions(IResolvable value) A list of `MemberDefinition` objects that contains objects that identify the workers that make up the work team.
void	setMemberDefinitions(List<Object> value) A list of `MemberDefinition` objects that contains objects that identify the workers that make up the work team.
void	setNotificationConfiguration(CfnWorkteam.NotificationConfigurationProperty value) Configures SNS notifications of available or expiring work items for work teams.
void	setNotificationConfiguration(IResolvable value) Configures SNS notifications of available or expiring work items for work teams.
void	setWorkteamName(String value) The name of the work team.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnWorkteam

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

CfnWorkteam

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

CfnWorkteam

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnWorkteam

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrWorkteamName()

The name of the work team.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the work team.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the work team.

getMemberDefinitions

@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
public Object getNotificationConfiguration()

Configures SNS notifications of available or expiring work items for work teams.

setNotificationConfiguration

@Stability(value=Stable)
public void setNotificationConfiguration(@Nullable
                                                                  CfnWorkteam.NotificationConfigurationProperty value)

Configures SNS notifications of available or expiring work items for work teams.

setNotificationConfiguration

@Stability(value=Stable)
public void setNotificationConfiguration(@Nullable
                                                                  IResolvable value)

Configures SNS notifications of available or expiring work items for work teams.

getWorkteamName

@Stability(value=Stable)
 @Nullable
public String getWorkteamName()

The name of the work team.

setWorkteamName

@Stability(value=Stable)
public void setWorkteamName(@Nullable
                                                     String value)

The name of the work team.