software.amazon.awscdk.services.sagemaker

Class CfnWorkteam

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.002Z")
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();
 

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.
static interface	CfnWorkteam.OidcMemberDefinitionProperty A list of user groups that exist in your OIDC Identity Provider (IdP).

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWorkteam(Construct scope, java.lang.String id) Create a new `AWS::SageMaker::Workteam`.
	CfnWorkteam(Construct scope, java.lang.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
java.lang.String	getAttrWorkteamName() The name of the work team.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of the work team.
java.lang.Object	getMemberDefinitions() A list of `MemberDefinition` objects that contains objects that identify the workers that make up the work team.
java.lang.Object	getNotificationConfiguration() Configures SNS notifications of available or expiring work items for work teams.
TagManager	getTags() An array of key-value pairs.
java.lang.String	getWorkforceName() `AWS::SageMaker::Workteam.WorkforceName`.
java.lang.String	getWorkteamName() The name of the work team.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.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(java.util.List<java.lang.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	setWorkforceName(java.lang.String value) `AWS::SageMaker::Workteam.WorkforceName`.
void	setWorkteamName(java.lang.String value) The name of the work team.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnWorkteam(Construct scope,
                   java.lang.String id,
                   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

public CfnWorkteam(Construct scope,
                   java.lang.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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrWorkteamName

public java.lang.String getAttrWorkteamName()

The name of the work team.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs.

getDescription

public java.lang.String getDescription()

A description of the work team.

setDescription

public void setDescription(java.lang.String value)

A description of the work team.

getMemberDefinitions

public java.lang.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

public void setMemberDefinitions(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

public void setMemberDefinitions(java.util.List<java.lang.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

public java.lang.Object getNotificationConfiguration()

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

setNotificationConfiguration

public void setNotificationConfiguration(IResolvable value)

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

setNotificationConfiguration

public void setNotificationConfiguration(CfnWorkteam.NotificationConfigurationProperty value)

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

getWorkforceName

public java.lang.String getWorkforceName()

`AWS::SageMaker::Workteam.WorkforceName`.

setWorkforceName

public void setWorkforceName(java.lang.String value)

`AWS::SageMaker::Workteam.WorkforceName`.

getWorkteamName

public java.lang.String getWorkteamName()

The name of the work team.

setWorkteamName

public void setWorkteamName(java.lang.String value)

The name of the work team.