UserProfile class

Provides a SageMaker AI User Profile resource.

Example Usage

Basic usage

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

const example = new aws.sagemaker.UserProfile("example", {
    domainId: test.id,
    userProfileName: "example",
});
import pulumi
import pulumi_aws as aws

example = aws.sagemaker.UserProfile("example",
    domain_id=test["id"],
    user_profile_name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Sagemaker.UserProfile("example", new()
    {
        DomainId = test.Id,
        UserProfileName = "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.NewUserProfile(ctx, "example", &sagemaker.UserProfileArgs{
			DomainId:        pulumi.Any(test.Id),
			UserProfileName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_userprofile" "example" {
  domain_id         = test.id
  user_profile_name = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.UserProfile;
import com.pulumi.aws.sagemaker.UserProfileArgs;
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 UserProfile("example", UserProfileArgs.builder()
            .domainId(test.id())
            .userProfileName("example")
            .build());

    }
}
resources:
  example:
    type: aws:sagemaker:UserProfile
    properties:
      domainId: ${test.id}
      userProfileName: example

Import

Identity Schema

Required

  • domainId (String) SageMaker domain ID.
  • userProfileName (String) Name of the user profile.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import SageMaker AI User Profiles using the arn. For example:

$ pulumi import aws:sagemaker/userProfile:UserProfile example arn:aws:sagemaker:us-west-2:123456789012:user-profile/domain-id/profile-name

Constructors

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

Properties

arn ↔ Output<String>
User profile ARN.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domainId ↔ Output<String>
The ID of the associated Domain.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
homeEfsFileSystemUid ↔ Output<String>
The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
latefinal
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
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
singleSignOnUserIdentifier ↔ Output<String?>
A specifier for the type of value specified in singleSignOnUserValue. Currently, the only supported value is UserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
latefinal
singleSignOnUserValue ↔ Output<String?>
The username of the associated AWS Single Sign-On User for this User Profile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
latefinal
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
userProfileName ↔ Output<String>
The name for the User Profile.
latefinal
userSettings ↔ Output<UserProfileUserSettings?>
The user settings. See User Settings 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, {UserProfileState? state, CustomResourceOptions? options}) → UserProfile
Gets an existing UserProfile resource's state with the given name and id.