interface CfnWorkteamProps

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnWorkteamProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnWorkteamProps
Java	software.amazon.awscdk.services.sagemaker.CfnWorkteamProps
Python	aws_cdk.aws_sagemaker.CfnWorkteamProps
TypeScript	aws-cdk-lib » aws_sagemaker » CfnWorkteamProps

Properties for defining a CfnWorkteam.

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

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

Name	Type	Description
description?	string	A 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 | NotificationConfigurationProperty	Configures SNS notifications of available or expiring work items for work teams.
tags?	CfnTag[]	An array of key-value pairs.
workforceName?	string	The name of the workforce.
workteamName?	string	The name of the work team.

---

description?

Type: string (optional)

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

---

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 .

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

---

notificationConfiguration?

Type: IResolvable | NotificationConfigurationProperty (optional)

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

---

tags?

Type: CfnTag[] (optional)

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

---

workforceName?

Type: string (optional)

The name of the workforce.

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

---

workteamName?

Type: string (optional)

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