CfnWorkteamProps

class aws_cdk.aws_sagemaker.CfnWorkteamProps(*, description=None, member_definitions=None, notification_configuration=None, tags=None, workteam_name=None)

Bases: object

Properties for defining a CfnWorkteam.

Parameters
  • description (Optional[str]) – A description of the work team.

  • member_definitions (Union[IResolvable, Sequence[Union[IResolvable, MemberDefinitionProperty]], None]) – 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 .

  • notification_configuration (Union[IResolvable, NotificationConfigurationProperty, None]) – Configures SNS notifications of available or expiring work items for work teams.

  • tags (Optional[Sequence[CfnTag]]) – An array of key-value pairs.

  • workteam_name (Optional[str]) – The name of the work team.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sagemaker as sagemaker

cfn_workteam_props = sagemaker.CfnWorkteamProps(
    description="description",
    member_definitions=[sagemaker.CfnWorkteam.MemberDefinitionProperty(
        cognito_member_definition=sagemaker.CfnWorkteam.CognitoMemberDefinitionProperty(
            cognito_client_id="cognitoClientId",
            cognito_user_group="cognitoUserGroup",
            cognito_user_pool="cognitoUserPool"
        )
    )],
    notification_configuration=sagemaker.CfnWorkteam.NotificationConfigurationProperty(
        notification_topic_arn="notificationTopicArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    workteam_name="workteamName"
)

Attributes

description

A description of the work team.

Link

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

Return type

Optional[str]

member_definitions

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 .

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, MemberDefinitionProperty]], None]

notification_configuration

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

Link

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

Return type

Union[IResolvable, NotificationConfigurationProperty, None]

tags

An array of key-value pairs.

Link

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

Return type

Optional[List[CfnTag]]

workteam_name

The name of the work team.

Link

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

Return type

Optional[str]