CfnWorkteamPropsMixin

class aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnWorkteamPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a new work team for labeling your data.

A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-workteam.html
CloudformationResource:: AWS::SageMaker::Workteam
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_workteam_props_mixin = sagemaker_mixins.CfnWorkteamPropsMixin(sagemaker_mixins.CfnWorkteamMixinProps(
    description="description",
    member_definitions=[sagemaker_mixins.CfnWorkteamPropsMixin.MemberDefinitionProperty(
        cognito_member_definition=sagemaker_mixins.CfnWorkteamPropsMixin.CognitoMemberDefinitionProperty(
            cognito_client_id="cognitoClientId",
            cognito_user_group="cognitoUserGroup",
            cognito_user_pool="cognitoUserPool"
        ),
        oidc_member_definition=sagemaker_mixins.CfnWorkteamPropsMixin.OidcMemberDefinitionProperty(
            oidc_groups=["oidcGroups"]
        )
    )],
    notification_configuration=sagemaker_mixins.CfnWorkteamPropsMixin.NotificationConfigurationProperty(
        notification_topic_arn="notificationTopicArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    workforce_name="workforceName",
    workteam_name="workteamName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SageMaker::Workteam.

Parameters:

props (Union[CfnWorkteamMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'memberDefinitions', 'notificationConfiguration', 'tags', 'workforceName', 'workteamName']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CognitoMemberDefinitionProperty

class CfnWorkteamPropsMixin.CognitoMemberDefinitionProperty(*, cognito_client_id=None, cognito_user_group=None, cognito_user_pool=None)

Bases: object

Identifies a Amazon Cognito user group.

A user group can be used in on or more work teams.

Parameters:

cognito_client_id (Optional[str]) – An identifier for an application client. You must create the app client ID using Amazon Cognito .
cognito_user_group (Optional[str]) – An identifier for a user group.
cognito_user_pool (Optional[str]) – An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cognito_member_definition_property = sagemaker_mixins.CfnWorkteamPropsMixin.CognitoMemberDefinitionProperty(
    cognito_client_id="cognitoClientId",
    cognito_user_group="cognitoUserGroup",
    cognito_user_pool="cognitoUserPool"
)

Attributes

cognito_client_id

An identifier for an application client.

You must create the app client ID using Amazon Cognito .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitoclientid

cognito_user_group

An identifier for a user group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitousergroup

cognito_user_pool

An identifier for a user pool.

The user pool must be in the same region as the service that you are calling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-cognitomemberdefinition.html#cfn-sagemaker-workteam-cognitomemberdefinition-cognitouserpool

MemberDefinitionProperty

class CfnWorkteamPropsMixin.MemberDefinitionProperty(*, cognito_member_definition=None, oidc_member_definition=None)

Bases: object

Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

Parameters:

cognito_member_definition (Union[IResolvable, CognitoMemberDefinitionProperty, Dict[str, Any], None]) – The Amazon Cognito user group that is part of the work team.
oidc_member_definition (Union[IResolvable, OidcMemberDefinitionProperty, Dict[str, Any], None]) – A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups , you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

member_definition_property = sagemaker_mixins.CfnWorkteamPropsMixin.MemberDefinitionProperty(
    cognito_member_definition=sagemaker_mixins.CfnWorkteamPropsMixin.CognitoMemberDefinitionProperty(
        cognito_client_id="cognitoClientId",
        cognito_user_group="cognitoUserGroup",
        cognito_user_pool="cognitoUserPool"
    ),
    oidc_member_definition=sagemaker_mixins.CfnWorkteamPropsMixin.OidcMemberDefinitionProperty(
        oidc_groups=["oidcGroups"]
    )
)

Attributes

cognito_member_definition

The Amazon Cognito user group that is part of the work team.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html#cfn-sagemaker-workteam-memberdefinition-cognitomemberdefinition

oidc_member_definition

A list user groups that exist in your OIDC Identity Provider (IdP).

One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups , you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-memberdefinition.html#cfn-sagemaker-workteam-memberdefinition-oidcmemberdefinition

NotificationConfigurationProperty

class CfnWorkteamPropsMixin.NotificationConfigurationProperty(*, notification_topic_arn=None)

Bases: object

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

Parameters:: notification_topic_arn (Optional[str]) – The ARN for the Amazon SNS topic to which notifications should be published.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-notificationconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

notification_configuration_property = sagemaker_mixins.CfnWorkteamPropsMixin.NotificationConfigurationProperty(
    notification_topic_arn="notificationTopicArn"
)

Attributes

notification_topic_arn

The ARN for the Amazon SNS topic to which notifications should be published.

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

OidcMemberDefinitionProperty

class CfnWorkteamPropsMixin.OidcMemberDefinitionProperty(*, oidc_groups=None)

Bases: object

A list of user groups that exist in your OIDC Identity Provider (IdP).

One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups , you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

Parameters:: oidc_groups (Optional[Sequence[str]])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-oidcmemberdefinition.html
ExampleMetadata:: fixture=_generated

Example:

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

oidc_member_definition_property = sagemaker_mixins.CfnWorkteamPropsMixin.OidcMemberDefinitionProperty(
    oidc_groups=["oidcGroups"]
)

Attributes

oidc_groups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-workteam-oidcmemberdefinition.html#cfn-sagemaker-workteam-oidcmemberdefinition-oidcgroups

Type:: see