aws-cdk-lib.aws_sagemaker.CfnWorkteamProps

interface CfnWorkteamProps

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnWorkteamProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnWorkteamProps
Javasoftware.amazon.awscdk.services.sagemaker.CfnWorkteamProps
Pythonaws_cdk.aws_sagemaker.CfnWorkteamProps
TypeScript aws-cdk-lib » aws_sagemaker » 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 { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnWorkteamProps: sagemaker.CfnWorkteamProps = {
  description: 'description',
  memberDefinitions: [{
    cognitoMemberDefinition: {
      cognitoClientId: 'cognitoClientId',
      cognitoUserGroup: 'cognitoUserGroup',
      cognitoUserPool: 'cognitoUserPool',
    },
    oidcMemberDefinition: {
      oidcGroups: ['oidcGroups'],
    },
  }],
  notificationConfiguration: {
    notificationTopicArn: 'notificationTopicArn',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  workforceName: 'workforceName',
  workteamName: 'workteamName',
};

Properties

NameTypeDescription
description?stringA description of the work team.
memberDefinitions?IResolvable | IResolvable | MemberDefinitionProperty[]A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
notificationConfiguration?IResolvable | NotificationConfigurationPropertyConfigures SNS notifications of available or expiring work items for work teams.
tags?CfnTag[]An array of key-value pairs.
workforceName?stringAWS::SageMaker::Workteam.WorkforceName.
workteamName?stringThe name of the work team.

description?

Type: string (optional)

A description of the work team.


memberDefinitions?

Type: IResolvable | IResolvable | MemberDefinitionProperty[] (optional)

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 .


notificationConfiguration?

Type: IResolvable | NotificationConfigurationProperty (optional)

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


tags?

Type: CfnTag[] (optional)

An array of key-value pairs.


workforceName?

Type: string (optional)

AWS::SageMaker::Workteam.WorkforceName.


workteamName?

Type: string (optional)

The name of the work team.