@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:40.002Z") public class CfnWorkteam extends CfnResource implements IInspectable
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();
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).
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnWorkteam(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnWorkteam(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnWorkteam(Construct scope, java.lang.String id, CfnWorkteamProps props)
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.public CfnWorkteam(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrWorkteamName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Object getMemberDefinitions()
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
.
public void setMemberDefinitions(IResolvable value)
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
.
public void setMemberDefinitions(java.util.List<java.lang.Object> value)
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
.
public java.lang.Object getNotificationConfiguration()
public void setNotificationConfiguration(IResolvable value)
public void setNotificationConfiguration(CfnWorkteam.NotificationConfigurationProperty value)
public java.lang.String getWorkforceName()
public void setWorkforceName(java.lang.String value)
public java.lang.String getWorkteamName()
public void setWorkteamName(java.lang.String value)