Workforce class

Provides a SageMaker AI Workforce resource.

Example Usage

Cognito Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleUserPool = new aws.cognito.UserPool("example", {name: "example"});
const exampleUserPoolClient = new aws.cognito.UserPoolClient("example", {
    name: "example",
    generateSecret: true,
    userPoolId: exampleUserPool.id,
});
const exampleUserPoolDomain = new aws.cognito.UserPoolDomain("example", {
    domain: "example",
    userPoolId: exampleUserPool.id,
});
const example = new aws.sagemaker.Workforce("example", {
    cognitoConfig: {
        clientId: exampleUserPoolClient.id,
        userPool: exampleUserPoolDomain.userPoolId,
    },
    workforceName: "example",
});

import pulumi
import pulumi_aws as aws

example_user_pool = aws.cognito.UserPool("example", name="example")
example_user_pool_client = aws.cognito.UserPoolClient("example",
    name="example",
    generate_secret=True,
    user_pool_id=example_user_pool.id)
example_user_pool_domain = aws.cognito.UserPoolDomain("example",
    domain="example",
    user_pool_id=example_user_pool.id)
example = aws.sagemaker.Workforce("example",
    cognito_config={
        "client_id": example_user_pool_client.id,
        "user_pool": example_user_pool_domain.user_pool_id,
    },
    workforce_name="example")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var exampleUserPool = new Aws.Cognito.UserPool("example", new()
    {
        Name = "example",
    });

    var exampleUserPoolClient = new Aws.Cognito.UserPoolClient("example", new()
    {
        Name = "example",
        GenerateSecret = true,
        UserPoolId = exampleUserPool.Id,
    });

    var exampleUserPoolDomain = new Aws.Cognito.UserPoolDomain("example", new()
    {
        Domain = "example",
        UserPoolId = exampleUserPool.Id,
    });

    var example = new Aws.Sagemaker.Workforce("example", new()
    {
        CognitoConfig = new Aws.Sagemaker.Inputs.WorkforceCognitoConfigArgs
        {
            ClientId = exampleUserPoolClient.Id,
            UserPool = exampleUserPoolDomain.UserPoolId,
        },
        WorkforceName = "example",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleUserPool, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleUserPoolClient, err := cognito.NewUserPoolClient(ctx, "example", &cognito.UserPoolClientArgs{
			Name:           pulumi.String("example"),
			GenerateSecret: pulumi.Bool(true),
			UserPoolId:     exampleUserPool.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		exampleUserPoolDomain, err := cognito.NewUserPoolDomain(ctx, "example", &cognito.UserPoolDomainArgs{
			Domain:     pulumi.String("example"),
			UserPoolId: exampleUserPool.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		_, err = sagemaker.NewWorkforce(ctx, "example", &sagemaker.WorkforceArgs{
			CognitoConfig: &sagemaker.WorkforceCognitoConfigArgs{
				ClientId: exampleUserPoolClient.ID().ToIDOutput().ToStringOutput(),
				UserPool: exampleUserPoolDomain.UserPoolId,
			},
			WorkforceName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_workforce" "example" {
  cognito_config = {
    client_id = aws_cognito_userpoolclient.example.id
    user_pool = aws_cognito_userpooldomain.example.user_pool_id
  }
  workforce_name = "example"
}
resource "aws_cognito_userpool" "example" {
  name = "example"
}
resource "aws_cognito_userpoolclient" "example" {
  name            = "example"
  generate_secret = true
  user_pool_id    = aws_cognito_userpool.example.id
}
resource "aws_cognito_userpooldomain" "example" {
  domain       = "example"
  user_pool_id = aws_cognito_userpool.example.id
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.UserPool;
import com.pulumi.aws.cognito.UserPoolArgs;
import com.pulumi.aws.cognito.UserPoolClient;
import com.pulumi.aws.cognito.UserPoolClientArgs;
import com.pulumi.aws.cognito.UserPoolDomain;
import com.pulumi.aws.cognito.UserPoolDomainArgs;
import com.pulumi.aws.sagemaker.Workforce;
import com.pulumi.aws.sagemaker.WorkforceArgs;
import com.pulumi.aws.sagemaker.inputs.WorkforceCognitoConfigArgs;
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 exampleUserPool = new UserPool("exampleUserPool", UserPoolArgs.builder()
            .name("example")
            .build());

        var exampleUserPoolClient = new UserPoolClient("exampleUserPoolClient", UserPoolClientArgs.builder()
            .name("example")
            .generateSecret(true)
            .userPoolId(exampleUserPool.id())
            .build());

        var exampleUserPoolDomain = new UserPoolDomain("exampleUserPoolDomain", UserPoolDomainArgs.builder()
            .domain("example")
            .userPoolId(exampleUserPool.id())
            .build());

        var example = new Workforce("example", WorkforceArgs.builder()
            .cognitoConfig(WorkforceCognitoConfigArgs.builder()
                .clientId(exampleUserPoolClient.id())
                .userPool(exampleUserPoolDomain.userPoolId())
                .build())
            .workforceName("example")
            .build());

    }
}

resources:
  example:
    type: aws:sagemaker:Workforce
    properties:
      cognitoConfig:
        clientId: ${exampleUserPoolClient.id}
        userPool: ${exampleUserPoolDomain.userPoolId}
      workforceName: example
  exampleUserPool:
    type: aws:cognito:UserPool
    name: example
    properties:
      name: example
  exampleUserPoolClient:
    type: aws:cognito:UserPoolClient
    name: example
    properties:
      name: example
      generateSecret: true
      userPoolId: ${exampleUserPool.id}
  exampleUserPoolDomain:
    type: aws:cognito:UserPoolDomain
    name: example
    properties:
      domain: example
      userPoolId: ${exampleUserPool.id}

Oidc Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.sagemaker.Workforce("example", {
    oidcConfig: {
        authorizationEndpoint: "https://example.com",
        clientId: "example",
        clientSecret: "example",
        issuer: "https://example.com",
        jwksUri: "https://example.com",
        logoutEndpoint: "https://example.com",
        tokenEndpoint: "https://example.com",
        userInfoEndpoint: "https://example.com",
    },
    workforceName: "example",
});

import pulumi
import pulumi_aws as aws

example = aws.sagemaker.Workforce("example",
    oidc_config={
        "authorization_endpoint": "https://example.com",
        "client_id": "example",
        "client_secret": "example",
        "issuer": "https://example.com",
        "jwks_uri": "https://example.com",
        "logout_endpoint": "https://example.com",
        "token_endpoint": "https://example.com",
        "user_info_endpoint": "https://example.com",
    },
    workforce_name="example")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Sagemaker.Workforce("example", new()
    {
        OidcConfig = new Aws.Sagemaker.Inputs.WorkforceOidcConfigArgs
        {
            AuthorizationEndpoint = "https://example.com",
            ClientId = "example",
            ClientSecret = "example",
            Issuer = "https://example.com",
            JwksUri = "https://example.com",
            LogoutEndpoint = "https://example.com",
            TokenEndpoint = "https://example.com",
            UserInfoEndpoint = "https://example.com",
        },
        WorkforceName = "example",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewWorkforce(ctx, "example", &sagemaker.WorkforceArgs{
			OidcConfig: &sagemaker.WorkforceOidcConfigArgs{
				AuthorizationEndpoint: pulumi.String("https://example.com"),
				ClientId:              pulumi.String("example"),
				ClientSecret:          pulumi.String("example"),
				Issuer:                pulumi.String("https://example.com"),
				JwksUri:               pulumi.String("https://example.com"),
				LogoutEndpoint:        pulumi.String("https://example.com"),
				TokenEndpoint:         pulumi.String("https://example.com"),
				UserInfoEndpoint:      pulumi.String("https://example.com"),
			},
			WorkforceName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_workforce" "example" {
  oidc_config = {
    authorization_endpoint = "https://example.com"
    client_id              = "example"
    client_secret          = "example"
    issuer                 = "https://example.com"
    jwks_uri               = "https://example.com"
    logout_endpoint        = "https://example.com"
    token_endpoint         = "https://example.com"
    user_info_endpoint     = "https://example.com"
  }
  workforce_name = "example"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Workforce;
import com.pulumi.aws.sagemaker.WorkforceArgs;
import com.pulumi.aws.sagemaker.inputs.WorkforceOidcConfigArgs;
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 Workforce("example", WorkforceArgs.builder()
            .oidcConfig(WorkforceOidcConfigArgs.builder()
                .authorizationEndpoint("https://example.com")
                .clientId("example")
                .clientSecret("example")
                .issuer("https://example.com")
                .jwksUri("https://example.com")
                .logoutEndpoint("https://example.com")
                .tokenEndpoint("https://example.com")
                .userInfoEndpoint("https://example.com")
                .build())
            .workforceName("example")
            .build());

    }
}

resources:
  example:
    type: aws:sagemaker:Workforce
    properties:
      oidcConfig:
        authorizationEndpoint: https://example.com
        clientId: example
        clientSecret: example
        issuer: https://example.com
        jwksUri: https://example.com
        logoutEndpoint: https://example.com
        tokenEndpoint: https://example.com
        userInfoEndpoint: https://example.com
      workforceName: example

Import

Using pulumi import, import SageMaker AI Workforces using the workforceName. For example:

$ pulumi import aws:sagemaker/workforce:Workforce example example

Constructors

Workforce(String name, {WorkforceArgs? args, CustomResourceOptions? options})
Creates a new Workforce. name The Pulumi resource name. args Arguments used to configure this Workforce. The set of arguments for Workforce. options Resource options controlling this resource's behavior.
Workforce.reference(String urn)
Creates a typed reference to an existing Workforce resource.

Properties

arn ↔ Output<String>
ARN assigned by AWS to this Workforce.
latefinal
childResources → Set<Resource>
finalinherited
cognitoConfig ↔ Output<WorkforceCognitoConfig?>
Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool. Conflicts with oidcConfig. see Cognito Config details below.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
oidcConfig ↔ Output<WorkforceOidcConfig?>
Use this parameter to configure a private workforce using your own OIDC Identity Provider. Conflicts with cognitoConfig. see OIDC Config details below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceIpConfig ↔ Output<WorkforceSourceIpConfig>
A list of IP address ranges Used to create an allow list of IP addresses for a private workforce. By default, a workforce isn't restricted to specific IP addresses. see Source Ip Config details below.
latefinal
subdomain ↔ Output<String>
The subdomain for your OIDC Identity Provider.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
workforceName ↔ Output<String>
The name of the Workforce (must be unique).
latefinal
workforceVpcConfig ↔ Output<WorkforceWorkforceVpcConfig?>
configure a workforce using VPC. see Workforce VPC Config details below.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {WorkforceState? state, CustomResourceOptions? options}) → Workforce
Gets an existing Workforce resource's state with the given name and id.