software.amazon.awscdk.services.sagemaker

Interface CfnWorkteamProps

All Known Implementing Classes:

CfnWorkteamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.006Z")
public interface CfnWorkteamProps

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getDescription

default java.lang.String getDescription()

A description of the work team.

getMemberDefinitions

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

getNotificationConfiguration

default java.lang.Object getNotificationConfiguration()

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

getTags

default java.util.List<CfnTag> getTags()

An array of key-value pairs.

getWorkforceName

default java.lang.String getWorkforceName()

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

getWorkteamName

default java.lang.String getWorkteamName()

The name of the work team.

builder

static CfnWorkteamProps.Builder builder()

Returns:

a CfnWorkteamProps.Builder of CfnWorkteamProps