Package com.pulumi.aws.sagemaker

Class Workteam

  • public class Workteam
extends com.pulumi.resources.CustomResource
    Provides a SageMaker AI Workteam resource. ## Example Usage ### Cognito Usage 
     
 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.ArrayList;
 import java.util.Arrays;
 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()
             .memberDefinitions(WorkteamMemberDefinitionArgs.builder()
                 .cognitoMemberDefinition(WorkteamMemberDefinitionCognitoMemberDefinitionArgs.builder()
                     .clientId(exampleAwsCognitoUserPoolClient.id())
                     .userPool(exampleAwsCognitoUserPoolDomain.userPoolId())
                     .userGroup(exampleAwsCognitoUserGroup.name())
                     .build())
                 .build())
             .workteamName("example")
             .workforceName(exampleAwsSagemakerWorkforce.id())
             .description("example")
             .build());
 
     }
 }
    ### OIDC Usage 
     
 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.ArrayList;
 import java.util.Arrays;
 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()
             .memberDefinitions(WorkteamMemberDefinitionArgs.builder()
                 .oidcMemberDefinition(WorkteamMemberDefinitionOidcMemberDefinitionArgs.builder()
                     .groups("example")
                     .build())
                 .build())
             .workteamName("example")
             .workforceName(exampleAwsSagemakerWorkforce.id())
             .description("example")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import SageMaker AI Workteams using the `workteamName`. For example: ```sh $ pulumi import aws:sagemaker/workteam:Workteam example example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Workteam​(java.lang.String name)  
      Workteam​(java.lang.String name, WorkteamArgs args)  
      Workteam​(java.lang.String name, WorkteamArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> description()  
      static Workteam get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, WorkteamState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.List<WorkteamMemberDefinition>> memberDefinitions()  
      com.pulumi.core.Output<java.util.Optional<WorkteamNotificationConfiguration>> notificationConfiguration()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> subdomain()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<WorkteamWorkerAccessConfiguration> workerAccessConfiguration()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> workforceName()  
      com.pulumi.core.Output<java.lang.String> workteamName()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Workteam

        public Workteam​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Workteam

        public Workteam​(java.lang.String name,
                WorkteamArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Workteam

        public Workteam​(java.lang.String name,
                WorkteamArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN assigned by AWS to this Workteam.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        A description of the work team.

      • memberDefinitions

        public com.pulumi.core.Output<java.util.List<WorkteamMemberDefinition>> memberDefinitions()
        Returns:
        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 `cognitoMemberDefinition`. For workforces created using your own OIDC identity provider (IdP) use `oidcMemberDefinition`. Do not provide input for both of these parameters in a single request. see Member Definition details below.

      • notificationConfiguration

        public com.pulumi.core.Output<java.util.Optional<WorkteamNotificationConfiguration>> notificationConfiguration()
        Returns:
        Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • subdomain

        public com.pulumi.core.Output<java.lang.String> subdomain()
        Returns:
        The subdomain for your OIDC Identity Provider.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • workerAccessConfiguration

        public com.pulumi.core.Output<WorkteamWorkerAccessConfiguration> workerAccessConfiguration()
        Returns:
        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.

      • workforceName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> workforceName()
        Returns:
        The name of the workforce.

      • workteamName

        public com.pulumi.core.Output<java.lang.String> workteamName()
        Returns:
        The name of the Workteam (must be unique).

      • get

        public static Workteam get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           WorkteamState state,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.