aws.sagemaker.Workteam
Explore with Pulumi AI
Provides a SageMaker Workteam resource.
Example Usage
Cognito Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.Workteam("example", {
workteamName: "example",
workforceName: exampleAwsSagemakerWorkforce.id,
description: "example",
memberDefinitions: [{
cognitoMemberDefinition: {
clientId: exampleAwsCognitoUserPoolClient.id,
userPool: exampleAwsCognitoUserPoolDomain.userPoolId,
userGroup: exampleAwsCognitoUserGroup.name,
},
}],
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.Workteam("example",
workteam_name="example",
workforce_name=example_aws_sagemaker_workforce["id"],
description="example",
member_definitions=[{
"cognito_member_definition": {
"client_id": example_aws_cognito_user_pool_client["id"],
"user_pool": example_aws_cognito_user_pool_domain["userPoolId"],
"user_group": example_aws_cognito_user_group["name"],
},
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sagemaker.NewWorkteam(ctx, "example", &sagemaker.WorkteamArgs{
WorkteamName: pulumi.String("example"),
WorkforceName: pulumi.Any(exampleAwsSagemakerWorkforce.Id),
Description: pulumi.String("example"),
MemberDefinitions: sagemaker.WorkteamMemberDefinitionArray{
&sagemaker.WorkteamMemberDefinitionArgs{
CognitoMemberDefinition: &sagemaker.WorkteamMemberDefinitionCognitoMemberDefinitionArgs{
ClientId: pulumi.Any(exampleAwsCognitoUserPoolClient.Id),
UserPool: pulumi.Any(exampleAwsCognitoUserPoolDomain.UserPoolId),
UserGroup: pulumi.Any(exampleAwsCognitoUserGroup.Name),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.Workteam("example", new()
{
WorkteamName = "example",
WorkforceName = exampleAwsSagemakerWorkforce.Id,
Description = "example",
MemberDefinitions = new[]
{
new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionArgs
{
CognitoMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionCognitoMemberDefinitionArgs
{
ClientId = exampleAwsCognitoUserPoolClient.Id,
UserPool = exampleAwsCognitoUserPoolDomain.UserPoolId,
UserGroup = exampleAwsCognitoUserGroup.Name,
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Workteam;
import com.pulumi.aws.sagemaker.WorkteamArgs;
import com.pulumi.aws.sagemaker.inputs.WorkteamMemberDefinitionArgs;
import com.pulumi.aws.sagemaker.inputs.WorkteamMemberDefinitionCognitoMemberDefinitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Workteam("example", WorkteamArgs.builder()
.workteamName("example")
.workforceName(exampleAwsSagemakerWorkforce.id())
.description("example")
.memberDefinitions(WorkteamMemberDefinitionArgs.builder()
.cognitoMemberDefinition(WorkteamMemberDefinitionCognitoMemberDefinitionArgs.builder()
.clientId(exampleAwsCognitoUserPoolClient.id())
.userPool(exampleAwsCognitoUserPoolDomain.userPoolId())
.userGroup(exampleAwsCognitoUserGroup.name())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:sagemaker:Workteam
properties:
workteamName: example
workforceName: ${exampleAwsSagemakerWorkforce.id}
description: example
memberDefinitions:
- cognitoMemberDefinition:
clientId: ${exampleAwsCognitoUserPoolClient.id}
userPool: ${exampleAwsCognitoUserPoolDomain.userPoolId}
userGroup: ${exampleAwsCognitoUserGroup.name}
Oidc Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.Workteam("example", {
workteamName: "example",
workforceName: exampleAwsSagemakerWorkforce.id,
description: "example",
memberDefinitions: [{
oidcMemberDefinition: {
groups: ["example"],
},
}],
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.Workteam("example",
workteam_name="example",
workforce_name=example_aws_sagemaker_workforce["id"],
description="example",
member_definitions=[{
"oidc_member_definition": {
"groups": ["example"],
},
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sagemaker.NewWorkteam(ctx, "example", &sagemaker.WorkteamArgs{
WorkteamName: pulumi.String("example"),
WorkforceName: pulumi.Any(exampleAwsSagemakerWorkforce.Id),
Description: pulumi.String("example"),
MemberDefinitions: sagemaker.WorkteamMemberDefinitionArray{
&sagemaker.WorkteamMemberDefinitionArgs{
OidcMemberDefinition: &sagemaker.WorkteamMemberDefinitionOidcMemberDefinitionArgs{
Groups: pulumi.StringArray{
pulumi.String("example"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.Workteam("example", new()
{
WorkteamName = "example",
WorkforceName = exampleAwsSagemakerWorkforce.Id,
Description = "example",
MemberDefinitions = new[]
{
new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionArgs
{
OidcMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionOidcMemberDefinitionArgs
{
Groups = new[]
{
"example",
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Workteam;
import com.pulumi.aws.sagemaker.WorkteamArgs;
import com.pulumi.aws.sagemaker.inputs.WorkteamMemberDefinitionArgs;
import com.pulumi.aws.sagemaker.inputs.WorkteamMemberDefinitionOidcMemberDefinitionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Workteam("example", WorkteamArgs.builder()
.workteamName("example")
.workforceName(exampleAwsSagemakerWorkforce.id())
.description("example")
.memberDefinitions(WorkteamMemberDefinitionArgs.builder()
.oidcMemberDefinition(WorkteamMemberDefinitionOidcMemberDefinitionArgs.builder()
.groups("example")
.build())
.build())
.build());
}
}
resources:
example:
type: aws:sagemaker:Workteam
properties:
workteamName: example
workforceName: ${exampleAwsSagemakerWorkforce.id}
description: example
memberDefinitions:
- oidcMemberDefinition:
groups:
- example
Create Workteam Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Workteam(name: string, args: WorkteamArgs, opts?: CustomResourceOptions);
@overload
def Workteam(resource_name: str,
args: WorkteamArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Workteam(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
member_definitions: Optional[Sequence[WorkteamMemberDefinitionArgs]] = None,
workteam_name: Optional[str] = None,
notification_configuration: Optional[WorkteamNotificationConfigurationArgs] = None,
tags: Optional[Mapping[str, str]] = None,
worker_access_configuration: Optional[WorkteamWorkerAccessConfigurationArgs] = None,
workforce_name: Optional[str] = None)
func NewWorkteam(ctx *Context, name string, args WorkteamArgs, opts ...ResourceOption) (*Workteam, error)
public Workteam(string name, WorkteamArgs args, CustomResourceOptions? opts = null)
public Workteam(String name, WorkteamArgs args)
public Workteam(String name, WorkteamArgs args, CustomResourceOptions options)
type: aws:sagemaker:Workteam
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WorkteamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WorkteamArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WorkteamArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkteamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkteamArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var workteamResource = new Aws.Sagemaker.Workteam("workteamResource", new()
{
Description = "string",
MemberDefinitions = new[]
{
new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionArgs
{
CognitoMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionCognitoMemberDefinitionArgs
{
ClientId = "string",
UserGroup = "string",
UserPool = "string",
},
OidcMemberDefinition = new Aws.Sagemaker.Inputs.WorkteamMemberDefinitionOidcMemberDefinitionArgs
{
Groups = new[]
{
"string",
},
},
},
},
WorkteamName = "string",
NotificationConfiguration = new Aws.Sagemaker.Inputs.WorkteamNotificationConfigurationArgs
{
NotificationTopicArn = "string",
},
Tags =
{
{ "string", "string" },
},
WorkerAccessConfiguration = new Aws.Sagemaker.Inputs.WorkteamWorkerAccessConfigurationArgs
{
S3Presign = new Aws.Sagemaker.Inputs.WorkteamWorkerAccessConfigurationS3PresignArgs
{
IamPolicyConstraints = new Aws.Sagemaker.Inputs.WorkteamWorkerAccessConfigurationS3PresignIamPolicyConstraintsArgs
{
SourceIp = "string",
VpcSourceIp = "string",
},
},
},
WorkforceName = "string",
});
example, err := sagemaker.NewWorkteam(ctx, "workteamResource", &sagemaker.WorkteamArgs{
Description: pulumi.String("string"),
MemberDefinitions: sagemaker.WorkteamMemberDefinitionArray{
&sagemaker.WorkteamMemberDefinitionArgs{
CognitoMemberDefinition: &sagemaker.WorkteamMemberDefinitionCognitoMemberDefinitionArgs{
ClientId: pulumi.String("string"),
UserGroup: pulumi.String("string"),
UserPool: pulumi.String("string"),
},
OidcMemberDefinition: &sagemaker.WorkteamMemberDefinitionOidcMemberDefinitionArgs{
Groups: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
WorkteamName: pulumi.String("string"),
NotificationConfiguration: &sagemaker.WorkteamNotificationConfigurationArgs{
NotificationTopicArn: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
WorkerAccessConfiguration: &sagemaker.WorkteamWorkerAccessConfigurationArgs{
S3Presign: &sagemaker.WorkteamWorkerAccessConfigurationS3PresignArgs{
IamPolicyConstraints: &sagemaker.WorkteamWorkerAccessConfigurationS3PresignIamPolicyConstraintsArgs{
SourceIp: pulumi.String("string"),
VpcSourceIp: pulumi.String("string"),
},
},
},
WorkforceName: pulumi.String("string"),
})
var workteamResource = new Workteam("workteamResource", WorkteamArgs.builder()
.description("string")
.memberDefinitions(WorkteamMemberDefinitionArgs.builder()
.cognitoMemberDefinition(WorkteamMemberDefinitionCognitoMemberDefinitionArgs.builder()
.clientId("string")
.userGroup("string")
.userPool("string")
.build())
.oidcMemberDefinition(WorkteamMemberDefinitionOidcMemberDefinitionArgs.builder()
.groups("string")
.build())
.build())
.workteamName("string")
.notificationConfiguration(WorkteamNotificationConfigurationArgs.builder()
.notificationTopicArn("string")
.build())
.tags(Map.of("string", "string"))
.workerAccessConfiguration(WorkteamWorkerAccessConfigurationArgs.builder()
.s3Presign(WorkteamWorkerAccessConfigurationS3PresignArgs.builder()
.iamPolicyConstraints(WorkteamWorkerAccessConfigurationS3PresignIamPolicyConstraintsArgs.builder()
.sourceIp("string")
.vpcSourceIp("string")
.build())
.build())
.build())
.workforceName("string")
.build());
workteam_resource = aws.sagemaker.Workteam("workteamResource",
description="string",
member_definitions=[{
"cognito_member_definition": {
"client_id": "string",
"user_group": "string",
"user_pool": "string",
},
"oidc_member_definition": {
"groups": ["string"],
},
}],
workteam_name="string",
notification_configuration={
"notification_topic_arn": "string",
},
tags={
"string": "string",
},
worker_access_configuration={
"s3_presign": {
"iam_policy_constraints": {
"source_ip": "string",
"vpc_source_ip": "string",
},
},
},
workforce_name="string")
const workteamResource = new aws.sagemaker.Workteam("workteamResource", {
description: "string",
memberDefinitions: [{
cognitoMemberDefinition: {
clientId: "string",
userGroup: "string",
userPool: "string",
},
oidcMemberDefinition: {
groups: ["string"],
},
}],
workteamName: "string",
notificationConfiguration: {
notificationTopicArn: "string",
},
tags: {
string: "string",
},
workerAccessConfiguration: {
s3Presign: {
iamPolicyConstraints: {
sourceIp: "string",
vpcSourceIp: "string",
},
},
},
workforceName: "string",
});
type: aws:sagemaker:Workteam
properties:
description: string
memberDefinitions:
- cognitoMemberDefinition:
clientId: string
userGroup: string
userPool: string
oidcMemberDefinition:
groups:
- string
notificationConfiguration:
notificationTopicArn: string
tags:
string: string
workerAccessConfiguration:
s3Presign:
iamPolicyConstraints:
sourceIp: string
vpcSourceIp: string
workforceName: string
workteamName: string
Workteam Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Workteam resource accepts the following input properties:
- Description string
- A description of the work team.
- Member
Definitions List<WorkteamMember Definition> - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - Workteam
Name string - The name of the Workteam (must be unique).
- Notification
Configuration WorkteamNotification Configuration - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Worker
Access WorkteamConfiguration Worker Access Configuration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- Workforce
Name string - The name of the workforce.
- Description string
- A description of the work team.
- Member
Definitions []WorkteamMember Definition Args - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - Workteam
Name string - The name of the Workteam (must be unique).
- Notification
Configuration WorkteamNotification Configuration Args - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- map[string]string
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Worker
Access WorkteamConfiguration Worker Access Configuration Args - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- Workforce
Name string - The name of the workforce.
- description String
- A description of the work team.
- member
Definitions List<WorkteamMember Definition> - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - workteam
Name String - The name of the Workteam (must be unique).
- notification
Configuration WorkteamNotification Configuration - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- Map<String,String>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - worker
Access WorkteamConfiguration Worker Access Configuration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- workforce
Name String - The name of the workforce.
- description string
- A description of the work team.
- member
Definitions WorkteamMember Definition[] - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - workteam
Name string - The name of the Workteam (must be unique).
- notification
Configuration WorkteamNotification Configuration - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - worker
Access WorkteamConfiguration Worker Access Configuration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- workforce
Name string - The name of the workforce.
- description str
- A description of the work team.
- member_
definitions Sequence[WorkteamMember Definition Args] - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - workteam_
name str - The name of the Workteam (must be unique).
- notification_
configuration WorkteamNotification Configuration Args - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - worker_
access_ Workteamconfiguration Worker Access Configuration Args - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- workforce_
name str - The name of the workforce.
- description String
- A description of the work team.
- member
Definitions List<Property Map> - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - workteam
Name String - The name of the Workteam (must be unique).
- notification
Configuration Property Map - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- Map<String>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - worker
Access Property MapConfiguration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- workforce
Name String - The name of the workforce.
Outputs
All input properties are implicitly available as output properties. Additionally, the Workteam resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- Id string
- The provider-assigned unique ID for this managed resource.
- Subdomain string
- The subdomain for your OIDC Identity Provider.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- Id string
- The provider-assigned unique ID for this managed resource.
- Subdomain string
- The subdomain for your OIDC Identity Provider.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- id String
- The provider-assigned unique ID for this managed resource.
- subdomain String
- The subdomain for your OIDC Identity Provider.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- id string
- The provider-assigned unique ID for this managed resource.
- subdomain string
- The subdomain for your OIDC Identity Provider.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- id str
- The provider-assigned unique ID for this managed resource.
- subdomain str
- The subdomain for your OIDC Identity Provider.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- id String
- The provider-assigned unique ID for this managed resource.
- subdomain String
- The subdomain for your OIDC Identity Provider.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing Workteam Resource
Get an existing Workteam resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: WorkteamState, opts?: CustomResourceOptions): Workteam
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
description: Optional[str] = None,
member_definitions: Optional[Sequence[WorkteamMemberDefinitionArgs]] = None,
notification_configuration: Optional[WorkteamNotificationConfigurationArgs] = None,
subdomain: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
worker_access_configuration: Optional[WorkteamWorkerAccessConfigurationArgs] = None,
workforce_name: Optional[str] = None,
workteam_name: Optional[str] = None) -> Workteam
func GetWorkteam(ctx *Context, name string, id IDInput, state *WorkteamState, opts ...ResourceOption) (*Workteam, error)
public static Workteam Get(string name, Input<string> id, WorkteamState? state, CustomResourceOptions? opts = null)
public static Workteam get(String name, Output<String> id, WorkteamState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- Description string
- A description of the work team.
- Member
Definitions List<WorkteamMember Definition> - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - Notification
Configuration WorkteamNotification Configuration - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- Subdomain string
- The subdomain for your OIDC Identity Provider.
- Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Worker
Access WorkteamConfiguration Worker Access Configuration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- Workforce
Name string - The name of the workforce.
- Workteam
Name string - The name of the Workteam (must be unique).
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- Description string
- A description of the work team.
- Member
Definitions []WorkteamMember Definition Args - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - Notification
Configuration WorkteamNotification Configuration Args - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- Subdomain string
- The subdomain for your OIDC Identity Provider.
- map[string]string
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Worker
Access WorkteamConfiguration Worker Access Configuration Args - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- Workforce
Name string - The name of the workforce.
- Workteam
Name string - The name of the Workteam (must be unique).
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- description String
- A description of the work team.
- member
Definitions List<WorkteamMember Definition> - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - notification
Configuration WorkteamNotification Configuration - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- subdomain String
- The subdomain for your OIDC Identity Provider.
- Map<String,String>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - worker
Access WorkteamConfiguration Worker Access Configuration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- workforce
Name String - The name of the workforce.
- workteam
Name String - The name of the Workteam (must be unique).
- arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- description string
- A description of the work team.
- member
Definitions WorkteamMember Definition[] - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - notification
Configuration WorkteamNotification Configuration - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- subdomain string
- The subdomain for your OIDC Identity Provider.
- {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - worker
Access WorkteamConfiguration Worker Access Configuration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- workforce
Name string - The name of the workforce.
- workteam
Name string - The name of the Workteam (must be unique).
- arn str
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- description str
- A description of the work team.
- member_
definitions Sequence[WorkteamMember Definition Args] - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - notification_
configuration WorkteamNotification Configuration Args - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- subdomain str
- The subdomain for your OIDC Identity Provider.
- Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - worker_
access_ Workteamconfiguration Worker Access Configuration Args - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- workforce_
name str - The name of the workforce.
- workteam_
name str - The name of the Workteam (must be unique).
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
- description String
- A description of the work team.
- member
Definitions List<Property Map> - 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 use
cognito_member_definition
. For workforces created using your own OIDC identity provider (IdP) useoidc_member_definition
. Do not provide input for both of these parameters in a single request. see Member Definition details below. - notification
Configuration Property Map - Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
- subdomain String
- The subdomain for your OIDC Identity Provider.
- Map<String>
- A map of tags to assign to the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - worker
Access Property MapConfiguration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL. see Worker Access Configuration details below.
- workforce
Name String - The name of the workforce.
- workteam
Name String - The name of the Workteam (must be unique).
Supporting Types
WorkteamMemberDefinition, WorkteamMemberDefinitionArgs
- Cognito
Member WorkteamDefinition Member Definition Cognito Member Definition - The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
- Oidc
Member WorkteamDefinition Member Definition 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. See Cognito Member Definition details below.
- Cognito
Member WorkteamDefinition Member Definition Cognito Member Definition - The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
- Oidc
Member WorkteamDefinition Member Definition 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. See Cognito Member Definition details below.
- cognito
Member WorkteamDefinition Member Definition Cognito Member Definition - The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
- oidc
Member WorkteamDefinition Member Definition 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. See Cognito Member Definition details below.
- cognito
Member WorkteamDefinition Member Definition Cognito Member Definition - The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
- oidc
Member WorkteamDefinition Member Definition 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. See Cognito Member Definition details below.
- cognito_
member_ Workteamdefinition Member Definition Cognito Member Definition - The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
- oidc_
member_ Workteamdefinition Member Definition 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. See Cognito Member Definition details below.
- cognito
Member Property MapDefinition - The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
- oidc
Member Property MapDefinition - 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.
WorkteamMemberDefinitionCognitoMemberDefinition, WorkteamMemberDefinitionCognitoMemberDefinitionArgs
- client_
id str - An identifier for an application client. You must create the app client ID using Amazon Cognito.
- user_
group str - An identifier for a user group.
- user_
pool str - An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
WorkteamMemberDefinitionOidcMemberDefinition, WorkteamMemberDefinitionOidcMemberDefinitionArgs
- Groups List<string>
- 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.
- Groups []string
- 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.
- groups List<String>
- 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.
- groups string[]
- 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.
- groups Sequence[str]
- 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.
- groups List<String>
- 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.
WorkteamNotificationConfiguration, WorkteamNotificationConfigurationArgs
- Notification
Topic stringArn - The ARN for the SNS topic to which notifications should be published.
- Notification
Topic stringArn - The ARN for the SNS topic to which notifications should be published.
- notification
Topic StringArn - The ARN for the SNS topic to which notifications should be published.
- notification
Topic stringArn - The ARN for the SNS topic to which notifications should be published.
- notification_
topic_ strarn - The ARN for the SNS topic to which notifications should be published.
- notification
Topic StringArn - The ARN for the SNS topic to which notifications should be published.
WorkteamWorkerAccessConfiguration, WorkteamWorkerAccessConfigurationArgs
- S3Presign
Workteam
Worker Access Configuration S3Presign - Defines any Amazon S3 resource constraints. see S3 Presign details below.
- S3Presign
Workteam
Worker Access Configuration S3Presign - Defines any Amazon S3 resource constraints. see S3 Presign details below.
- s3Presign
Workteam
Worker Access Configuration S3Presign - Defines any Amazon S3 resource constraints. see S3 Presign details below.
- s3Presign
Workteam
Worker Access Configuration S3Presign - Defines any Amazon S3 resource constraints. see S3 Presign details below.
- s3_
presign WorkteamWorker Access Configuration S3Presign - Defines any Amazon S3 resource constraints. see S3 Presign details below.
- s3Presign Property Map
- Defines any Amazon S3 resource constraints. see S3 Presign details below.
WorkteamWorkerAccessConfigurationS3Presign, WorkteamWorkerAccessConfigurationS3PresignArgs
- Iam
Policy WorkteamConstraints Worker Access Configuration S3Presign Iam Policy Constraints - Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp. see IAM Policy Constraints details below.
- Iam
Policy WorkteamConstraints Worker Access Configuration S3Presign Iam Policy Constraints - Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp. see IAM Policy Constraints details below.
- iam
Policy WorkteamConstraints Worker Access Configuration S3Presign Iam Policy Constraints - Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp. see IAM Policy Constraints details below.
- iam
Policy WorkteamConstraints Worker Access Configuration S3Presign Iam Policy Constraints - Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp. see IAM Policy Constraints details below.
- iam_
policy_ Workteamconstraints Worker Access Configuration S3Presign Iam Policy Constraints - Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp. see IAM Policy Constraints details below.
- iam
Policy Property MapConstraints - Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp. see IAM Policy Constraints details below.
WorkteamWorkerAccessConfigurationS3PresignIamPolicyConstraints, WorkteamWorkerAccessConfigurationS3PresignIamPolicyConstraintsArgs
- Source
Ip string - When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal. Valid values are
Enabled
orDisabled
- Vpc
Source stringIp - When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal. Valid values are
Enabled
orDisabled
- Source
Ip string - When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal. Valid values are
Enabled
orDisabled
- Vpc
Source stringIp - When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal. Valid values are
Enabled
orDisabled
- source
Ip String - When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal. Valid values are
Enabled
orDisabled
- vpc
Source StringIp - When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal. Valid values are
Enabled
orDisabled
- source
Ip string - When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal. Valid values are
Enabled
orDisabled
- vpc
Source stringIp - When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal. Valid values are
Enabled
orDisabled
- source_
ip str - When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal. Valid values are
Enabled
orDisabled
- vpc_
source_ strip - When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal. Valid values are
Enabled
orDisabled
- source
Ip String - When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal. Valid values are
Enabled
orDisabled
- vpc
Source StringIp - When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal. Valid values are
Enabled
orDisabled
Import
Using pulumi import
, import SageMaker Workteams using the workteam_name
. For example:
$ pulumi import aws:sagemaker/workteam:Workteam example example
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.