Resource: awsSagemakerWorkteam
Provides a SageMaker Workteam resource.
Example Usage
Cognito Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.sagemakerWorkteam.SagemakerWorkteam(this, "example", {
description: "example",
memberDefinition: [
{
cognitoMemberDefinition: {
clientId: "${aws_cognito_user_pool_client.example.id}",
userGroup: "${aws_cognito_user_group.example.id}",
userPool: "${aws_cognito_user_pool_domain.example.user_pool_id}",
},
},
],
workforceName: "${aws_sagemaker_workforce.example.id}",
workteamName: "example",
});
Oidc Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.sagemakerWorkteam.SagemakerWorkteam(this, "example", {
description: "example",
memberDefinition: [
{
oidcMemberDefinition: {
groups: ["example"],
},
},
],
workforceName: "${aws_sagemaker_workforce.example.id}",
workteamName: "example",
});
Argument Reference
The following arguments are supported:
description
- (Required) A description of the work team.workforceName
- (Required) The name of the Workteam (must be unique).workteamName
- (Required) The name of the workforce.memberDefinition
- (Required) A list of Member Definitions 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 usecognitoMemberDefinition
. For workforces created using your own OIDC identity provider (IdP) useoidcMemberDefinition
. Do not provide input for both of these parameters in a single request. see Member Definition details below.notificationConfiguration
- (Optional) Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.tags
- (Optional) A map of tags to assign to the resource. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Member Definition
cognitoMemberDefinition
- (Optional) The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.oidcMemberDefinition
- (Optional) 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. See Cognito Member Definition details below.
Cognito Member Definition
clientId
- (Required) An identifier for an application client. You must create the app client ID using Amazon Cognito.userPool
- (Required) An identifier for a user pool. The user pool must be in the same region as the service that you are calling.userGroup
- (Required) An identifier for a user group.
Oidc Member Definition
groups
- (Required) A list of comma separated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
Notification Configuration
notificationTopicArn
- (Required) The ARN for the SNS topic to which notifications should be published.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.id
- The name of the Workteam.subdomain
- The subdomain for your OIDC Identity Provider.tagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
SageMaker Workteams can be imported using the workteamName
, e.g.,