Package software.amazon.awscdk.services.sagemaker

Interface CfnWorkteamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkteamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.329Z")
@Stability(Stable)
public interface CfnWorkteamProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkteam.

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.*;
 CfnWorkteamProps cfnWorkteamProps = CfnWorkteamProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkteamProps.Builder	A builder for CfnWorkteamProps
static final class	CfnWorkteamProps.Jsii$Proxy	An implementation for CfnWorkteamProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkteamProps.Builder	builder()
default String	getDescription()	A description of the work team.
default Object	getMemberDefinitions()	A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
default Object	getNotificationConfiguration()	Configures SNS notifications of available or expiring work items for work teams.
default List<CfnTag>	getTags()	An array of key-value pairs.
default String	getWorkforceName()	The name of the workforce.
default String	getWorkteamName()	The name of the work team.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the work team.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-description

getMemberDefinitions

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-memberdefinitions

getNotificationConfiguration

@Stability(Stable)
@Nullable
default Object getNotificationConfiguration()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-notificationconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-tags

getWorkforceName

@Stability(Stable)
@Nullable
default String getWorkforceName()

The name of the workforce.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-workforcename

getWorkteamName

@Stability(Stable)
@Nullable
default String getWorkteamName()

The name of the work team.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html#cfn-sagemaker-workteam-workteamname

builder

@Stability(Stable)
static CfnWorkteamProps.Builder builder()

Returns:

a CfnWorkteamProps.Builder of CfnWorkteamProps