published on Tuesday, Mar 10, 2026 by Pulumi
published on Tuesday, Mar 10, 2026 by Pulumi
Provides a SageMaker User Profile resource.
Example Usage
Basic usage
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 = aws_sagemaker_domain.Test.Id,
UserProfileName = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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(aws_sagemaker_domain.Test.Id),
UserProfileName: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
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.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 UserProfile("example", UserProfileArgs.builder()
.domainId(aws_sagemaker_domain.test().id())
.userProfileName("example")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.UserProfile("example", {
domainId: aws_sagemaker_domain.test.id,
userProfileName: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.UserProfile("example",
domain_id=aws_sagemaker_domain["test"]["id"],
user_profile_name="example")
resources:
example:
type: aws:sagemaker:UserProfile
properties:
domainId: ${aws_sagemaker_domain.test.id}
userProfileName: example
Create UserProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UserProfile(name: string, args: UserProfileArgs, opts?: CustomResourceOptions);@overload
def UserProfile(resource_name: str,
args: UserProfileArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UserProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
domain_id: Optional[str] = None,
user_profile_name: Optional[str] = None,
single_sign_on_user_identifier: Optional[str] = None,
single_sign_on_user_value: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
user_settings: Optional[UserProfileUserSettingsArgs] = None)func NewUserProfile(ctx *Context, name string, args UserProfileArgs, opts ...ResourceOption) (*UserProfile, error)public UserProfile(string name, UserProfileArgs args, CustomResourceOptions? opts = null)
public UserProfile(String name, UserProfileArgs args)
public UserProfile(String name, UserProfileArgs args, CustomResourceOptions options)
type: aws:sagemaker:UserProfile
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 UserProfileArgs
- 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 UserProfileArgs
- 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 UserProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserProfileArgs
- 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 awsUserProfileResource = new Aws.Sagemaker.UserProfile("awsUserProfileResource", new()
{
DomainId = "string",
UserProfileName = "string",
SingleSignOnUserIdentifier = "string",
SingleSignOnUserValue = "string",
Tags =
{
{ "string", "string" },
},
UserSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsArgs
{
ExecutionRole = "string",
CanvasAppSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsCanvasAppSettingsArgs
{
ModelRegisterSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsCanvasAppSettingsModelRegisterSettingsArgs
{
CrossAccountModelRegisterRoleArn = "string",
Status = "string",
},
TimeSeriesForecastingSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsCanvasAppSettingsTimeSeriesForecastingSettingsArgs
{
AmazonForecastRoleArn = "string",
Status = "string",
},
},
JupyterServerAppSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsJupyterServerAppSettingsArgs
{
CodeRepositories = new[]
{
new Aws.Sagemaker.Inputs.UserProfileUserSettingsJupyterServerAppSettingsCodeRepositoryArgs
{
RepositoryUrl = "string",
},
},
DefaultResourceSpec = new Aws.Sagemaker.Inputs.UserProfileUserSettingsJupyterServerAppSettingsDefaultResourceSpecArgs
{
InstanceType = "string",
LifecycleConfigArn = "string",
SagemakerImageArn = "string",
SagemakerImageVersionArn = "string",
},
LifecycleConfigArns = new[]
{
"string",
},
},
KernelGatewayAppSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsKernelGatewayAppSettingsArgs
{
CustomImages = new[]
{
new Aws.Sagemaker.Inputs.UserProfileUserSettingsKernelGatewayAppSettingsCustomImageArgs
{
AppImageConfigName = "string",
ImageName = "string",
ImageVersionNumber = 0,
},
},
DefaultResourceSpec = new Aws.Sagemaker.Inputs.UserProfileUserSettingsKernelGatewayAppSettingsDefaultResourceSpecArgs
{
InstanceType = "string",
LifecycleConfigArn = "string",
SagemakerImageArn = "string",
SagemakerImageVersionArn = "string",
},
LifecycleConfigArns = new[]
{
"string",
},
},
RSessionAppSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsRSessionAppSettingsArgs
{
CustomImages = new[]
{
new Aws.Sagemaker.Inputs.UserProfileUserSettingsRSessionAppSettingsCustomImageArgs
{
AppImageConfigName = "string",
ImageName = "string",
ImageVersionNumber = 0,
},
},
DefaultResourceSpec = new Aws.Sagemaker.Inputs.UserProfileUserSettingsRSessionAppSettingsDefaultResourceSpecArgs
{
InstanceType = "string",
LifecycleConfigArn = "string",
SagemakerImageArn = "string",
SagemakerImageVersionArn = "string",
},
},
RStudioServerProAppSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsRStudioServerProAppSettingsArgs
{
AccessStatus = "string",
UserGroup = "string",
},
SecurityGroups = new[]
{
"string",
},
SharingSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsSharingSettingsArgs
{
NotebookOutputOption = "string",
S3KmsKeyId = "string",
S3OutputPath = "string",
},
TensorBoardAppSettings = new Aws.Sagemaker.Inputs.UserProfileUserSettingsTensorBoardAppSettingsArgs
{
DefaultResourceSpec = new Aws.Sagemaker.Inputs.UserProfileUserSettingsTensorBoardAppSettingsDefaultResourceSpecArgs
{
InstanceType = "string",
LifecycleConfigArn = "string",
SagemakerImageArn = "string",
SagemakerImageVersionArn = "string",
},
},
},
});
example, err := sagemaker.NewUserProfile(ctx, "awsUserProfileResource", &sagemaker.UserProfileArgs{
DomainId: pulumi.String("string"),
UserProfileName: pulumi.String("string"),
SingleSignOnUserIdentifier: pulumi.String("string"),
SingleSignOnUserValue: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
UserSettings: &sagemaker.UserProfileUserSettingsArgs{
ExecutionRole: pulumi.String("string"),
CanvasAppSettings: &sagemaker.UserProfileUserSettingsCanvasAppSettingsArgs{
ModelRegisterSettings: &sagemaker.UserProfileUserSettingsCanvasAppSettingsModelRegisterSettingsArgs{
CrossAccountModelRegisterRoleArn: pulumi.String("string"),
Status: pulumi.String("string"),
},
TimeSeriesForecastingSettings: &sagemaker.UserProfileUserSettingsCanvasAppSettingsTimeSeriesForecastingSettingsArgs{
AmazonForecastRoleArn: pulumi.String("string"),
Status: pulumi.String("string"),
},
},
JupyterServerAppSettings: &sagemaker.UserProfileUserSettingsJupyterServerAppSettingsArgs{
CodeRepositories: sagemaker.UserProfileUserSettingsJupyterServerAppSettingsCodeRepositoryArray{
&sagemaker.UserProfileUserSettingsJupyterServerAppSettingsCodeRepositoryArgs{
RepositoryUrl: pulumi.String("string"),
},
},
DefaultResourceSpec: &sagemaker.UserProfileUserSettingsJupyterServerAppSettingsDefaultResourceSpecArgs{
InstanceType: pulumi.String("string"),
LifecycleConfigArn: pulumi.String("string"),
SagemakerImageArn: pulumi.String("string"),
SagemakerImageVersionArn: pulumi.String("string"),
},
LifecycleConfigArns: pulumi.StringArray{
pulumi.String("string"),
},
},
KernelGatewayAppSettings: &sagemaker.UserProfileUserSettingsKernelGatewayAppSettingsArgs{
CustomImages: sagemaker.UserProfileUserSettingsKernelGatewayAppSettingsCustomImageArray{
&sagemaker.UserProfileUserSettingsKernelGatewayAppSettingsCustomImageArgs{
AppImageConfigName: pulumi.String("string"),
ImageName: pulumi.String("string"),
ImageVersionNumber: pulumi.Int(0),
},
},
DefaultResourceSpec: &sagemaker.UserProfileUserSettingsKernelGatewayAppSettingsDefaultResourceSpecArgs{
InstanceType: pulumi.String("string"),
LifecycleConfigArn: pulumi.String("string"),
SagemakerImageArn: pulumi.String("string"),
SagemakerImageVersionArn: pulumi.String("string"),
},
LifecycleConfigArns: pulumi.StringArray{
pulumi.String("string"),
},
},
RSessionAppSettings: &sagemaker.UserProfileUserSettingsRSessionAppSettingsArgs{
CustomImages: sagemaker.UserProfileUserSettingsRSessionAppSettingsCustomImageArray{
&sagemaker.UserProfileUserSettingsRSessionAppSettingsCustomImageArgs{
AppImageConfigName: pulumi.String("string"),
ImageName: pulumi.String("string"),
ImageVersionNumber: pulumi.Int(0),
},
},
DefaultResourceSpec: &sagemaker.UserProfileUserSettingsRSessionAppSettingsDefaultResourceSpecArgs{
InstanceType: pulumi.String("string"),
LifecycleConfigArn: pulumi.String("string"),
SagemakerImageArn: pulumi.String("string"),
SagemakerImageVersionArn: pulumi.String("string"),
},
},
RStudioServerProAppSettings: &sagemaker.UserProfileUserSettingsRStudioServerProAppSettingsArgs{
AccessStatus: pulumi.String("string"),
UserGroup: pulumi.String("string"),
},
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
SharingSettings: &sagemaker.UserProfileUserSettingsSharingSettingsArgs{
NotebookOutputOption: pulumi.String("string"),
S3KmsKeyId: pulumi.String("string"),
S3OutputPath: pulumi.String("string"),
},
TensorBoardAppSettings: &sagemaker.UserProfileUserSettingsTensorBoardAppSettingsArgs{
DefaultResourceSpec: &sagemaker.UserProfileUserSettingsTensorBoardAppSettingsDefaultResourceSpecArgs{
InstanceType: pulumi.String("string"),
LifecycleConfigArn: pulumi.String("string"),
SagemakerImageArn: pulumi.String("string"),
SagemakerImageVersionArn: pulumi.String("string"),
},
},
},
})
var awsUserProfileResource = new com.pulumi.aws.sagemaker.UserProfile("awsUserProfileResource", com.pulumi.aws.sagemaker.UserProfileArgs.builder()
.domainId("string")
.userProfileName("string")
.singleSignOnUserIdentifier("string")
.singleSignOnUserValue("string")
.tags(Map.of("string", "string"))
.userSettings(UserProfileUserSettingsArgs.builder()
.executionRole("string")
.canvasAppSettings(UserProfileUserSettingsCanvasAppSettingsArgs.builder()
.modelRegisterSettings(UserProfileUserSettingsCanvasAppSettingsModelRegisterSettingsArgs.builder()
.crossAccountModelRegisterRoleArn("string")
.status("string")
.build())
.timeSeriesForecastingSettings(UserProfileUserSettingsCanvasAppSettingsTimeSeriesForecastingSettingsArgs.builder()
.amazonForecastRoleArn("string")
.status("string")
.build())
.build())
.jupyterServerAppSettings(UserProfileUserSettingsJupyterServerAppSettingsArgs.builder()
.codeRepositories(UserProfileUserSettingsJupyterServerAppSettingsCodeRepositoryArgs.builder()
.repositoryUrl("string")
.build())
.defaultResourceSpec(UserProfileUserSettingsJupyterServerAppSettingsDefaultResourceSpecArgs.builder()
.instanceType("string")
.lifecycleConfigArn("string")
.sagemakerImageArn("string")
.sagemakerImageVersionArn("string")
.build())
.lifecycleConfigArns("string")
.build())
.kernelGatewayAppSettings(UserProfileUserSettingsKernelGatewayAppSettingsArgs.builder()
.customImages(UserProfileUserSettingsKernelGatewayAppSettingsCustomImageArgs.builder()
.appImageConfigName("string")
.imageName("string")
.imageVersionNumber(0)
.build())
.defaultResourceSpec(UserProfileUserSettingsKernelGatewayAppSettingsDefaultResourceSpecArgs.builder()
.instanceType("string")
.lifecycleConfigArn("string")
.sagemakerImageArn("string")
.sagemakerImageVersionArn("string")
.build())
.lifecycleConfigArns("string")
.build())
.rSessionAppSettings(UserProfileUserSettingsRSessionAppSettingsArgs.builder()
.customImages(UserProfileUserSettingsRSessionAppSettingsCustomImageArgs.builder()
.appImageConfigName("string")
.imageName("string")
.imageVersionNumber(0)
.build())
.defaultResourceSpec(UserProfileUserSettingsRSessionAppSettingsDefaultResourceSpecArgs.builder()
.instanceType("string")
.lifecycleConfigArn("string")
.sagemakerImageArn("string")
.sagemakerImageVersionArn("string")
.build())
.build())
.rStudioServerProAppSettings(UserProfileUserSettingsRStudioServerProAppSettingsArgs.builder()
.accessStatus("string")
.userGroup("string")
.build())
.securityGroups("string")
.sharingSettings(UserProfileUserSettingsSharingSettingsArgs.builder()
.notebookOutputOption("string")
.s3KmsKeyId("string")
.s3OutputPath("string")
.build())
.tensorBoardAppSettings(UserProfileUserSettingsTensorBoardAppSettingsArgs.builder()
.defaultResourceSpec(UserProfileUserSettingsTensorBoardAppSettingsDefaultResourceSpecArgs.builder()
.instanceType("string")
.lifecycleConfigArn("string")
.sagemakerImageArn("string")
.sagemakerImageVersionArn("string")
.build())
.build())
.build())
.build());
aws_user_profile_resource = aws.sagemaker.UserProfile("awsUserProfileResource",
domain_id="string",
user_profile_name="string",
single_sign_on_user_identifier="string",
single_sign_on_user_value="string",
tags={
"string": "string",
},
user_settings={
"execution_role": "string",
"canvas_app_settings": {
"model_register_settings": {
"cross_account_model_register_role_arn": "string",
"status": "string",
},
"time_series_forecasting_settings": {
"amazon_forecast_role_arn": "string",
"status": "string",
},
},
"jupyter_server_app_settings": {
"code_repositories": [{
"repository_url": "string",
}],
"default_resource_spec": {
"instance_type": "string",
"lifecycle_config_arn": "string",
"sagemaker_image_arn": "string",
"sagemaker_image_version_arn": "string",
},
"lifecycle_config_arns": ["string"],
},
"kernel_gateway_app_settings": {
"custom_images": [{
"app_image_config_name": "string",
"image_name": "string",
"image_version_number": 0,
}],
"default_resource_spec": {
"instance_type": "string",
"lifecycle_config_arn": "string",
"sagemaker_image_arn": "string",
"sagemaker_image_version_arn": "string",
},
"lifecycle_config_arns": ["string"],
},
"r_session_app_settings": {
"custom_images": [{
"app_image_config_name": "string",
"image_name": "string",
"image_version_number": 0,
}],
"default_resource_spec": {
"instance_type": "string",
"lifecycle_config_arn": "string",
"sagemaker_image_arn": "string",
"sagemaker_image_version_arn": "string",
},
},
"r_studio_server_pro_app_settings": {
"access_status": "string",
"user_group": "string",
},
"security_groups": ["string"],
"sharing_settings": {
"notebook_output_option": "string",
"s3_kms_key_id": "string",
"s3_output_path": "string",
},
"tensor_board_app_settings": {
"default_resource_spec": {
"instance_type": "string",
"lifecycle_config_arn": "string",
"sagemaker_image_arn": "string",
"sagemaker_image_version_arn": "string",
},
},
})
const awsUserProfileResource = new aws.sagemaker.UserProfile("awsUserProfileResource", {
domainId: "string",
userProfileName: "string",
singleSignOnUserIdentifier: "string",
singleSignOnUserValue: "string",
tags: {
string: "string",
},
userSettings: {
executionRole: "string",
canvasAppSettings: {
modelRegisterSettings: {
crossAccountModelRegisterRoleArn: "string",
status: "string",
},
timeSeriesForecastingSettings: {
amazonForecastRoleArn: "string",
status: "string",
},
},
jupyterServerAppSettings: {
codeRepositories: [{
repositoryUrl: "string",
}],
defaultResourceSpec: {
instanceType: "string",
lifecycleConfigArn: "string",
sagemakerImageArn: "string",
sagemakerImageVersionArn: "string",
},
lifecycleConfigArns: ["string"],
},
kernelGatewayAppSettings: {
customImages: [{
appImageConfigName: "string",
imageName: "string",
imageVersionNumber: 0,
}],
defaultResourceSpec: {
instanceType: "string",
lifecycleConfigArn: "string",
sagemakerImageArn: "string",
sagemakerImageVersionArn: "string",
},
lifecycleConfigArns: ["string"],
},
rSessionAppSettings: {
customImages: [{
appImageConfigName: "string",
imageName: "string",
imageVersionNumber: 0,
}],
defaultResourceSpec: {
instanceType: "string",
lifecycleConfigArn: "string",
sagemakerImageArn: "string",
sagemakerImageVersionArn: "string",
},
},
rStudioServerProAppSettings: {
accessStatus: "string",
userGroup: "string",
},
securityGroups: ["string"],
sharingSettings: {
notebookOutputOption: "string",
s3KmsKeyId: "string",
s3OutputPath: "string",
},
tensorBoardAppSettings: {
defaultResourceSpec: {
instanceType: "string",
lifecycleConfigArn: "string",
sagemakerImageArn: "string",
sagemakerImageVersionArn: "string",
},
},
},
});
type: aws:sagemaker:UserProfile
properties:
domainId: string
singleSignOnUserIdentifier: string
singleSignOnUserValue: string
tags:
string: string
userProfileName: string
userSettings:
canvasAppSettings:
modelRegisterSettings:
crossAccountModelRegisterRoleArn: string
status: string
timeSeriesForecastingSettings:
amazonForecastRoleArn: string
status: string
executionRole: string
jupyterServerAppSettings:
codeRepositories:
- repositoryUrl: string
defaultResourceSpec:
instanceType: string
lifecycleConfigArn: string
sagemakerImageArn: string
sagemakerImageVersionArn: string
lifecycleConfigArns:
- string
kernelGatewayAppSettings:
customImages:
- appImageConfigName: string
imageName: string
imageVersionNumber: 0
defaultResourceSpec:
instanceType: string
lifecycleConfigArn: string
sagemakerImageArn: string
sagemakerImageVersionArn: string
lifecycleConfigArns:
- string
rSessionAppSettings:
customImages:
- appImageConfigName: string
imageName: string
imageVersionNumber: 0
defaultResourceSpec:
instanceType: string
lifecycleConfigArn: string
sagemakerImageArn: string
sagemakerImageVersionArn: string
rStudioServerProAppSettings:
accessStatus: string
userGroup: string
securityGroups:
- string
sharingSettings:
notebookOutputOption: string
s3KmsKeyId: string
s3OutputPath: string
tensorBoardAppSettings:
defaultResourceSpec:
instanceType: string
lifecycleConfigArn: string
sagemakerImageArn: string
sagemakerImageVersionArn: string
UserProfile 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 UserProfile resource accepts the following input properties:
- Domain
Id string - The ID of the associated Domain.
- User
Profile stringName - The name for the User Profile.
- Single
Sign stringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - Single
Sign stringOn User Value - 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.
- Dictionary<string, string>
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - User
Settings UserProfile User Settings - The user settings. See User Settings below.
- Domain
Id string - The ID of the associated Domain.
- User
Profile stringName - The name for the User Profile.
- Single
Sign stringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - Single
Sign stringOn User Value - 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.
- map[string]string
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - User
Settings UserProfile User Settings Args - The user settings. See User Settings below.
- domain
Id String - The ID of the associated Domain.
- user
Profile StringName - The name for the User Profile.
- single
Sign StringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - single
Sign StringOn User Value - 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.
- Map<String,String>
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Settings UserProfile User Settings - The user settings. See User Settings below.
- domain
Id string - The ID of the associated Domain.
- user
Profile stringName - The name for the User Profile.
- single
Sign stringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - single
Sign stringOn User Value - 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.
- {[key: string]: string}
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Settings UserProfile User Settings - The user settings. See User Settings below.
- domain_
id str - The ID of the associated Domain.
- user_
profile_ strname - The name for the User Profile.
- single_
sign_ stron_ user_ identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - single_
sign_ stron_ user_ value - 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.
- Mapping[str, str]
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user_
settings UserProfile User Settings Args - The user settings. See User Settings below.
- domain
Id String - The ID of the associated Domain.
- user
Profile StringName - The name for the User Profile.
- single
Sign StringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - single
Sign StringOn User Value - 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.
- Map<String>
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Settings Property Map - The user settings. See User Settings below.
Outputs
All input properties are implicitly available as output properties. Additionally, the UserProfile resource produces the following output properties:
- Arn string
- The user profile Amazon Resource Name (ARN).
- Home
Efs stringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- Arn string
- The user profile Amazon Resource Name (ARN).
- Home
Efs stringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- The user profile Amazon Resource Name (ARN).
- home
Efs StringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn string
- The user profile Amazon Resource Name (ARN).
- home
Efs stringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn str
- The user profile Amazon Resource Name (ARN).
- home_
efs_ strfile_ system_ uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
- arn String
- The user profile Amazon Resource Name (ARN).
- home
Efs StringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.
Look up Existing UserProfile Resource
Get an existing UserProfile 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?: UserProfileState, opts?: CustomResourceOptions): UserProfile@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
domain_id: Optional[str] = None,
home_efs_file_system_uid: Optional[str] = None,
single_sign_on_user_identifier: Optional[str] = None,
single_sign_on_user_value: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
user_profile_name: Optional[str] = None,
user_settings: Optional[UserProfileUserSettingsArgs] = None) -> UserProfilefunc GetUserProfile(ctx *Context, name string, id IDInput, state *UserProfileState, opts ...ResourceOption) (*UserProfile, error)public static UserProfile Get(string name, Input<string> id, UserProfileState? state, CustomResourceOptions? opts = null)public static UserProfile get(String name, Output<String> id, UserProfileState state, CustomResourceOptions options)resources: _: type: aws:sagemaker:UserProfile get: id: ${id}- 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 user profile Amazon Resource Name (ARN).
- Domain
Id string - The ID of the associated Domain.
- Home
Efs stringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- Single
Sign stringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - Single
Sign stringOn User Value - 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.
- Dictionary<string, string>
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - User
Profile stringName - The name for the User Profile.
- User
Settings UserProfile User Settings - The user settings. See User Settings below.
- Arn string
- The user profile Amazon Resource Name (ARN).
- Domain
Id string - The ID of the associated Domain.
- Home
Efs stringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- Single
Sign stringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - Single
Sign stringOn User Value - 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.
- map[string]string
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - User
Profile stringName - The name for the User Profile.
- User
Settings UserProfile User Settings Args - The user settings. See User Settings below.
- arn String
- The user profile Amazon Resource Name (ARN).
- domain
Id String - The ID of the associated Domain.
- home
Efs StringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- single
Sign StringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - single
Sign StringOn User Value - 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.
- Map<String,String>
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - user
Profile StringName - The name for the User Profile.
- user
Settings UserProfile User Settings - The user settings. See User Settings below.
- arn string
- The user profile Amazon Resource Name (ARN).
- domain
Id string - The ID of the associated Domain.
- home
Efs stringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- single
Sign stringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - single
Sign stringOn User Value - 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.
- {[key: string]: string}
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - user
Profile stringName - The name for the User Profile.
- user
Settings UserProfile User Settings - The user settings. See User Settings below.
- arn str
- The user profile Amazon Resource Name (ARN).
- domain_
id str - The ID of the associated Domain.
- home_
efs_ strfile_ system_ uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- single_
sign_ stron_ user_ identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - single_
sign_ stron_ user_ value - 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.
- Mapping[str, str]
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - user_
profile_ strname - The name for the User Profile.
- user_
settings UserProfile User Settings Args - The user settings. See User Settings below.
- arn String
- The user profile Amazon Resource Name (ARN).
- domain
Id String - The ID of the associated Domain.
- home
Efs StringFile System Uid - The ID of the user's profile in the Amazon Elastic File System (EFS) volume.
- single
Sign StringOn User Identifier - A specifier for the type of value specified in
single_sign_on_user_value. Currently, the only supported value isUserName. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. - single
Sign StringOn User Value - 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.
- Map<String>
- A map of tags to assign to the resource. .If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - user
Profile StringName - The name for the User Profile.
- user
Settings Property Map - The user settings. See User Settings below.
Supporting Types
UserProfileUserSettings, UserProfileUserSettingsArgs
- Execution
Role string - The execution role ARN for the user.
- Canvas
App UserSettings Profile User Settings Canvas App Settings - The Canvas app settings. See Canvas App Settings below.
- Jupyter
Server UserApp Settings Profile User Settings Jupyter Server App Settings - The Jupyter server's app settings. See Jupyter Server App Settings below.
- Kernel
Gateway UserApp Settings Profile User Settings Kernel Gateway App Settings - The kernel gateway app settings. See Kernel Gateway App Settings below.
- RSession
App UserSettings Profile User Settings RSession App Settings - The RSession app settings. See RSession App Settings below.
- RStudio
Server UserPro App Settings Profile User Settings RStudio Server Pro App Settings - A collection of settings that configure user interaction with the RStudioServerPro app. See RStudio Server Pro App Settings below.
- Security
Groups List<string> - The security groups.
-
User
Profile User Settings Sharing Settings - The sharing settings. See Sharing Settings below.
- Tensor
Board UserApp Settings Profile User Settings Tensor Board App Settings - The TensorBoard app settings. See TensorBoard App Settings below.
- Execution
Role string - The execution role ARN for the user.
- Canvas
App UserSettings Profile User Settings Canvas App Settings - The Canvas app settings. See Canvas App Settings below.
- Jupyter
Server UserApp Settings Profile User Settings Jupyter Server App Settings - The Jupyter server's app settings. See Jupyter Server App Settings below.
- Kernel
Gateway UserApp Settings Profile User Settings Kernel Gateway App Settings - The kernel gateway app settings. See Kernel Gateway App Settings below.
- RSession
App UserSettings Profile User Settings RSession App Settings - The RSession app settings. See RSession App Settings below.
- RStudio
Server UserPro App Settings Profile User Settings RStudio Server Pro App Settings - A collection of settings that configure user interaction with the RStudioServerPro app. See RStudio Server Pro App Settings below.
- Security
Groups []string - The security groups.
-
User
Profile User Settings Sharing Settings - The sharing settings. See Sharing Settings below.
- Tensor
Board UserApp Settings Profile User Settings Tensor Board App Settings - The TensorBoard app settings. See TensorBoard App Settings below.
- execution
Role String - The execution role ARN for the user.
- canvas
App UserSettings Profile User Settings Canvas App Settings - The Canvas app settings. See Canvas App Settings below.
- jupyter
Server UserApp Settings Profile User Settings Jupyter Server App Settings - The Jupyter server's app settings. See Jupyter Server App Settings below.
- kernel
Gateway UserApp Settings Profile User Settings Kernel Gateway App Settings - The kernel gateway app settings. See Kernel Gateway App Settings below.
- r
Session UserApp Settings Profile User Settings RSession App Settings - The RSession app settings. See RSession App Settings below.
- r
Studio UserServer Pro App Settings Profile User Settings RStudio Server Pro App Settings - A collection of settings that configure user interaction with the RStudioServerPro app. See RStudio Server Pro App Settings below.
- security
Groups List<String> - The security groups.
-
User
Profile User Settings Sharing Settings - The sharing settings. See Sharing Settings below.
- tensor
Board UserApp Settings Profile User Settings Tensor Board App Settings - The TensorBoard app settings. See TensorBoard App Settings below.
- execution
Role string - The execution role ARN for the user.
- canvas
App UserSettings Profile User Settings Canvas App Settings - The Canvas app settings. See Canvas App Settings below.
- jupyter
Server UserApp Settings Profile User Settings Jupyter Server App Settings - The Jupyter server's app settings. See Jupyter Server App Settings below.
- kernel
Gateway UserApp Settings Profile User Settings Kernel Gateway App Settings - The kernel gateway app settings. See Kernel Gateway App Settings below.
- r
Session UserApp Settings Profile User Settings RSession App Settings - The RSession app settings. See RSession App Settings below.
- r
Studio UserServer Pro App Settings Profile User Settings RStudio Server Pro App Settings - A collection of settings that configure user interaction with the RStudioServerPro app. See RStudio Server Pro App Settings below.
- security
Groups string[] - The security groups.
-
User
Profile User Settings Sharing Settings - The sharing settings. See Sharing Settings below.
- tensor
Board UserApp Settings Profile User Settings Tensor Board App Settings - The TensorBoard app settings. See TensorBoard App Settings below.
- execution_
role str - The execution role ARN for the user.
- canvas_
app_ Usersettings Profile User Settings Canvas App Settings - The Canvas app settings. See Canvas App Settings below.
- jupyter_
server_ Userapp_ settings Profile User Settings Jupyter Server App Settings - The Jupyter server's app settings. See Jupyter Server App Settings below.
- kernel_
gateway_ Userapp_ settings Profile User Settings Kernel Gateway App Settings - The kernel gateway app settings. See Kernel Gateway App Settings below.
- r_
session_ Userapp_ settings Profile User Settings RSession App Settings - The RSession app settings. See RSession App Settings below.
- r_
studio_ Userserver_ pro_ app_ settings Profile User Settings RStudio Server Pro App Settings - A collection of settings that configure user interaction with the RStudioServerPro app. See RStudio Server Pro App Settings below.
- security_
groups Sequence[str] - The security groups.
-
User
Profile User Settings Sharing Settings - The sharing settings. See Sharing Settings below.
- tensor_
board_ Userapp_ settings Profile User Settings Tensor Board App Settings - The TensorBoard app settings. See TensorBoard App Settings below.
- execution
Role String - The execution role ARN for the user.
- canvas
App Property MapSettings - The Canvas app settings. See Canvas App Settings below.
- jupyter
Server Property MapApp Settings - The Jupyter server's app settings. See Jupyter Server App Settings below.
- kernel
Gateway Property MapApp Settings - The kernel gateway app settings. See Kernel Gateway App Settings below.
- r
Session Property MapApp Settings - The RSession app settings. See RSession App Settings below.
- r
Studio Property MapServer Pro App Settings - A collection of settings that configure user interaction with the RStudioServerPro app. See RStudio Server Pro App Settings below.
- security
Groups List<String> - The security groups.
- Property Map
- The sharing settings. See Sharing Settings below.
- tensor
Board Property MapApp Settings - The TensorBoard app settings. See TensorBoard App Settings below.
UserProfileUserSettingsCanvasAppSettings, UserProfileUserSettingsCanvasAppSettingsArgs
- Model
Register UserSettings Profile User Settings Canvas App Settings Model Register Settings - The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
- Time
Series UserForecasting Settings Profile User Settings Canvas App Settings Time Series Forecasting Settings - Time series forecast settings for the Canvas app. see Time Series Forecasting Settings below.
- Model
Register UserSettings Profile User Settings Canvas App Settings Model Register Settings - The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
- Time
Series UserForecasting Settings Profile User Settings Canvas App Settings Time Series Forecasting Settings - Time series forecast settings for the Canvas app. see Time Series Forecasting Settings below.
- model
Register UserSettings Profile User Settings Canvas App Settings Model Register Settings - The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
- time
Series UserForecasting Settings Profile User Settings Canvas App Settings Time Series Forecasting Settings - Time series forecast settings for the Canvas app. see Time Series Forecasting Settings below.
- model
Register UserSettings Profile User Settings Canvas App Settings Model Register Settings - The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
- time
Series UserForecasting Settings Profile User Settings Canvas App Settings Time Series Forecasting Settings - Time series forecast settings for the Canvas app. see Time Series Forecasting Settings below.
- model_
register_ Usersettings Profile User Settings Canvas App Settings Model Register Settings - The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
- time_
series_ Userforecasting_ settings Profile User Settings Canvas App Settings Time Series Forecasting Settings - Time series forecast settings for the Canvas app. see Time Series Forecasting Settings below.
- model
Register Property MapSettings - The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
- time
Series Property MapForecasting Settings - Time series forecast settings for the Canvas app. see Time Series Forecasting Settings below.
UserProfileUserSettingsCanvasAppSettingsModelRegisterSettings, UserProfileUserSettingsCanvasAppSettingsModelRegisterSettingsArgs
- Cross
Account stringModel Register Role Arn - The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas AWS account than the AWS account in which SageMaker model registry is set up.
- Status string
- Describes whether the integration to the model registry is enabled or disabled in the Canvas application.. Valid values are
ENABLEDandDISABLED.
- Cross
Account stringModel Register Role Arn - The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas AWS account than the AWS account in which SageMaker model registry is set up.
- Status string
- Describes whether the integration to the model registry is enabled or disabled in the Canvas application.. Valid values are
ENABLEDandDISABLED.
- cross
Account StringModel Register Role Arn - The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas AWS account than the AWS account in which SageMaker model registry is set up.
- status String
- Describes whether the integration to the model registry is enabled or disabled in the Canvas application.. Valid values are
ENABLEDandDISABLED.
- cross
Account stringModel Register Role Arn - The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas AWS account than the AWS account in which SageMaker model registry is set up.
- status string
- Describes whether the integration to the model registry is enabled or disabled in the Canvas application.. Valid values are
ENABLEDandDISABLED.
- cross_
account_ strmodel_ register_ role_ arn - The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas AWS account than the AWS account in which SageMaker model registry is set up.
- status str
- Describes whether the integration to the model registry is enabled or disabled in the Canvas application.. Valid values are
ENABLEDandDISABLED.
- cross
Account StringModel Register Role Arn - The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas AWS account than the AWS account in which SageMaker model registry is set up.
- status String
- Describes whether the integration to the model registry is enabled or disabled in the Canvas application.. Valid values are
ENABLEDandDISABLED.
UserProfileUserSettingsCanvasAppSettingsTimeSeriesForecastingSettings, UserProfileUserSettingsCanvasAppSettingsTimeSeriesForecastingSettingsArgs
- Amazon
Forecast stringRole Arn - The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
- Status string
- Describes whether time series forecasting is enabled or disabled in the Canvas app. Valid values are
ENABLEDandDISABLED.
- Amazon
Forecast stringRole Arn - The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
- Status string
- Describes whether time series forecasting is enabled or disabled in the Canvas app. Valid values are
ENABLEDandDISABLED.
- amazon
Forecast StringRole Arn - The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
- status String
- Describes whether time series forecasting is enabled or disabled in the Canvas app. Valid values are
ENABLEDandDISABLED.
- amazon
Forecast stringRole Arn - The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
- status string
- Describes whether time series forecasting is enabled or disabled in the Canvas app. Valid values are
ENABLEDandDISABLED.
- amazon_
forecast_ strrole_ arn - The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
- status str
- Describes whether time series forecasting is enabled or disabled in the Canvas app. Valid values are
ENABLEDandDISABLED.
- amazon
Forecast StringRole Arn - The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.
- status String
- Describes whether time series forecasting is enabled or disabled in the Canvas app. Valid values are
ENABLEDandDISABLED.
UserProfileUserSettingsJupyterServerAppSettings, UserProfileUserSettingsJupyterServerAppSettingsArgs
- Code
Repositories List<UserProfile User Settings Jupyter Server App Settings Code Repository> - A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
- Default
Resource UserSpec Profile User Settings Jupyter Server App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- Lifecycle
Config List<string>Arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- Code
Repositories []UserProfile User Settings Jupyter Server App Settings Code Repository - A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
- Default
Resource UserSpec Profile User Settings Jupyter Server App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- Lifecycle
Config []stringArns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- code
Repositories List<UserProfile User Settings Jupyter Server App Settings Code Repository> - A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
- default
Resource UserSpec Profile User Settings Jupyter Server App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- lifecycle
Config List<String>Arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- code
Repositories UserProfile User Settings Jupyter Server App Settings Code Repository[] - A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
- default
Resource UserSpec Profile User Settings Jupyter Server App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- lifecycle
Config string[]Arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- code_
repositories Sequence[UserProfile User Settings Jupyter Server App Settings Code Repository] - A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
- default_
resource_ Userspec Profile User Settings Jupyter Server App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- lifecycle_
config_ Sequence[str]arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- code
Repositories List<Property Map> - A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
- default
Resource Property MapSpec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- lifecycle
Config List<String>Arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
UserProfileUserSettingsJupyterServerAppSettingsCodeRepository, UserProfileUserSettingsJupyterServerAppSettingsCodeRepositoryArgs
- Repository
Url string - The URL of the Git repository.
- Repository
Url string - The URL of the Git repository.
- repository
Url String - The URL of the Git repository.
- repository
Url string - The URL of the Git repository.
- repository_
url str - The URL of the Git repository.
- repository
Url String - The URL of the Git repository.
UserProfileUserSettingsJupyterServerAppSettingsDefaultResourceSpec, UserProfileUserSettingsJupyterServerAppSettingsDefaultResourceSpecArgs
- Instance
Type string - The instance type.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- Instance
Type string - The instance type.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
- instance
Type string - The instance type.
- lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance_
type str - The instance type.
- lifecycle_
config_ strarn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker_
image_ strarn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker_
image_ strversion_ arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
UserProfileUserSettingsKernelGatewayAppSettings, UserProfileUserSettingsKernelGatewayAppSettingsArgs
- Custom
Images List<UserProfile User Settings Kernel Gateway App Settings Custom Image> - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- Default
Resource UserSpec Profile User Settings Kernel Gateway App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- Lifecycle
Config List<string>Arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- Custom
Images []UserProfile User Settings Kernel Gateway App Settings Custom Image - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- Default
Resource UserSpec Profile User Settings Kernel Gateway App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- Lifecycle
Config []stringArns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- custom
Images List<UserProfile User Settings Kernel Gateway App Settings Custom Image> - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- default
Resource UserSpec Profile User Settings Kernel Gateway App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- lifecycle
Config List<String>Arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- custom
Images UserProfile User Settings Kernel Gateway App Settings Custom Image[] - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- default
Resource UserSpec Profile User Settings Kernel Gateway App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- lifecycle
Config string[]Arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- custom_
images Sequence[UserProfile User Settings Kernel Gateway App Settings Custom Image] - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- default_
resource_ Userspec Profile User Settings Kernel Gateway App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- lifecycle_
config_ Sequence[str]arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
- custom
Images List<Property Map> - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- default
Resource Property MapSpec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- lifecycle
Config List<String>Arns - The Amazon Resource Name (ARN) of the Lifecycle Configurations.
UserProfileUserSettingsKernelGatewayAppSettingsCustomImage, UserProfileUserSettingsKernelGatewayAppSettingsCustomImageArgs
- App
Image stringConfig Name - The name of the App Image Config.
- Image
Name string - The name of the Custom Image.
- Image
Version intNumber - The version number of the Custom Image.
- App
Image stringConfig Name - The name of the App Image Config.
- Image
Name string - The name of the Custom Image.
- Image
Version intNumber - The version number of the Custom Image.
- app
Image StringConfig Name - The name of the App Image Config.
- image
Name String - The name of the Custom Image.
- image
Version IntegerNumber - The version number of the Custom Image.
- app
Image stringConfig Name - The name of the App Image Config.
- image
Name string - The name of the Custom Image.
- image
Version numberNumber - The version number of the Custom Image.
- app_
image_ strconfig_ name - The name of the App Image Config.
- image_
name str - The name of the Custom Image.
- image_
version_ intnumber - The version number of the Custom Image.
- app
Image StringConfig Name - The name of the App Image Config.
- image
Name String - The name of the Custom Image.
- image
Version NumberNumber - The version number of the Custom Image.
UserProfileUserSettingsKernelGatewayAppSettingsDefaultResourceSpec, UserProfileUserSettingsKernelGatewayAppSettingsDefaultResourceSpecArgs
- Instance
Type string - The instance type.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- Instance
Type string - The instance type.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
- instance
Type string - The instance type.
- lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance_
type str - The instance type.
- lifecycle_
config_ strarn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker_
image_ strarn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker_
image_ strversion_ arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
UserProfileUserSettingsRSessionAppSettings, UserProfileUserSettingsRSessionAppSettingsArgs
- Custom
Images List<UserProfile User Settings RSession App Settings Custom Image> - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- Default
Resource UserSpec Profile User Settings RSession App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- Custom
Images []UserProfile User Settings RSession App Settings Custom Image - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- Default
Resource UserSpec Profile User Settings RSession App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- custom
Images List<UserProfile User Settings RSession App Settings Custom Image> - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- default
Resource UserSpec Profile User Settings RSession App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- custom
Images UserProfile User Settings RSession App Settings Custom Image[] - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- default
Resource UserSpec Profile User Settings RSession App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- custom_
images Sequence[UserProfile User Settings RSession App Settings Custom Image] - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- default_
resource_ Userspec Profile User Settings RSession App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- custom
Images List<Property Map> - A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
- default
Resource Property MapSpec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
UserProfileUserSettingsRSessionAppSettingsCustomImage, UserProfileUserSettingsRSessionAppSettingsCustomImageArgs
- App
Image stringConfig Name - The name of the App Image Config.
- Image
Name string - The name of the Custom Image.
- Image
Version intNumber - The version number of the Custom Image.
- App
Image stringConfig Name - The name of the App Image Config.
- Image
Name string - The name of the Custom Image.
- Image
Version intNumber - The version number of the Custom Image.
- app
Image StringConfig Name - The name of the App Image Config.
- image
Name String - The name of the Custom Image.
- image
Version IntegerNumber - The version number of the Custom Image.
- app
Image stringConfig Name - The name of the App Image Config.
- image
Name string - The name of the Custom Image.
- image
Version numberNumber - The version number of the Custom Image.
- app_
image_ strconfig_ name - The name of the App Image Config.
- image_
name str - The name of the Custom Image.
- image_
version_ intnumber - The version number of the Custom Image.
- app
Image StringConfig Name - The name of the App Image Config.
- image
Name String - The name of the Custom Image.
- image
Version NumberNumber - The version number of the Custom Image.
UserProfileUserSettingsRSessionAppSettingsDefaultResourceSpec, UserProfileUserSettingsRSessionAppSettingsDefaultResourceSpecArgs
- Instance
Type string - The instance type.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- Instance
Type string - The instance type.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
- instance
Type string - The instance type.
- lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance_
type str - The instance type.
- lifecycle_
config_ strarn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker_
image_ strarn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker_
image_ strversion_ arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
UserProfileUserSettingsRStudioServerProAppSettings, UserProfileUserSettingsRStudioServerProAppSettingsArgs
- Access
Status string - Indicates whether the current user has access to the RStudioServerPro app. Valid values are
ENABLEDandDISABLED. - User
Group string - The level of permissions that the user has within the RStudioServerPro app. This value defaults to
R_STUDIO_USER. TheR_STUDIO_ADMINvalue allows the user access to the RStudio Administrative Dashboard. Valid values areR_STUDIO_USERandR_STUDIO_ADMIN.
- Access
Status string - Indicates whether the current user has access to the RStudioServerPro app. Valid values are
ENABLEDandDISABLED. - User
Group string - The level of permissions that the user has within the RStudioServerPro app. This value defaults to
R_STUDIO_USER. TheR_STUDIO_ADMINvalue allows the user access to the RStudio Administrative Dashboard. Valid values areR_STUDIO_USERandR_STUDIO_ADMIN.
- access
Status String - Indicates whether the current user has access to the RStudioServerPro app. Valid values are
ENABLEDandDISABLED. - user
Group String - The level of permissions that the user has within the RStudioServerPro app. This value defaults to
R_STUDIO_USER. TheR_STUDIO_ADMINvalue allows the user access to the RStudio Administrative Dashboard. Valid values areR_STUDIO_USERandR_STUDIO_ADMIN.
- access
Status string - Indicates whether the current user has access to the RStudioServerPro app. Valid values are
ENABLEDandDISABLED. - user
Group string - The level of permissions that the user has within the RStudioServerPro app. This value defaults to
R_STUDIO_USER. TheR_STUDIO_ADMINvalue allows the user access to the RStudio Administrative Dashboard. Valid values areR_STUDIO_USERandR_STUDIO_ADMIN.
- access_
status str - Indicates whether the current user has access to the RStudioServerPro app. Valid values are
ENABLEDandDISABLED. - user_
group str - The level of permissions that the user has within the RStudioServerPro app. This value defaults to
R_STUDIO_USER. TheR_STUDIO_ADMINvalue allows the user access to the RStudio Administrative Dashboard. Valid values areR_STUDIO_USERandR_STUDIO_ADMIN.
- access
Status String - Indicates whether the current user has access to the RStudioServerPro app. Valid values are
ENABLEDandDISABLED. - user
Group String - The level of permissions that the user has within the RStudioServerPro app. This value defaults to
R_STUDIO_USER. TheR_STUDIO_ADMINvalue allows the user access to the RStudio Administrative Dashboard. Valid values areR_STUDIO_USERandR_STUDIO_ADMIN.
UserProfileUserSettingsSharingSettings, UserProfileUserSettingsSharingSettingsArgs
- Notebook
Output stringOption - Whether to include the notebook cell output when sharing the notebook. The default is
Disabled. Valid values areAllowedandDisabled. - S3Kms
Key stringId - When
notebook_output_optionis Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. - S3Output
Path string - When
notebook_output_optionis Allowed, the Amazon S3 bucket used to save the notebook cell output.
- Notebook
Output stringOption - Whether to include the notebook cell output when sharing the notebook. The default is
Disabled. Valid values areAllowedandDisabled. - S3Kms
Key stringId - When
notebook_output_optionis Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. - S3Output
Path string - When
notebook_output_optionis Allowed, the Amazon S3 bucket used to save the notebook cell output.
- notebook
Output StringOption - Whether to include the notebook cell output when sharing the notebook. The default is
Disabled. Valid values areAllowedandDisabled. - s3Kms
Key StringId - When
notebook_output_optionis Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. - s3Output
Path String - When
notebook_output_optionis Allowed, the Amazon S3 bucket used to save the notebook cell output.
- notebook
Output stringOption - Whether to include the notebook cell output when sharing the notebook. The default is
Disabled. Valid values areAllowedandDisabled. - s3Kms
Key stringId - When
notebook_output_optionis Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. - s3Output
Path string - When
notebook_output_optionis Allowed, the Amazon S3 bucket used to save the notebook cell output.
- notebook_
output_ stroption - Whether to include the notebook cell output when sharing the notebook. The default is
Disabled. Valid values areAllowedandDisabled. - s3_
kms_ strkey_ id - When
notebook_output_optionis Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. - s3_
output_ strpath - When
notebook_output_optionis Allowed, the Amazon S3 bucket used to save the notebook cell output.
- notebook
Output StringOption - Whether to include the notebook cell output when sharing the notebook. The default is
Disabled. Valid values areAllowedandDisabled. - s3Kms
Key StringId - When
notebook_output_optionis Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. - s3Output
Path String - When
notebook_output_optionis Allowed, the Amazon S3 bucket used to save the notebook cell output.
UserProfileUserSettingsTensorBoardAppSettings, UserProfileUserSettingsTensorBoardAppSettingsArgs
- Default
Resource UserSpec Profile User Settings Tensor Board App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- Default
Resource UserSpec Profile User Settings Tensor Board App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- default
Resource UserSpec Profile User Settings Tensor Board App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- default
Resource UserSpec Profile User Settings Tensor Board App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- default_
resource_ Userspec Profile User Settings Tensor Board App Settings Default Resource Spec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
- default
Resource Property MapSpec - The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
UserProfileUserSettingsTensorBoardAppSettingsDefaultResourceSpec, UserProfileUserSettingsTensorBoardAppSettingsDefaultResourceSpecArgs
- Instance
Type string - The instance type.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- Instance
Type string - The instance type.
- Lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- Sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- Sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
- instance
Type string - The instance type.
- lifecycle
Config stringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image stringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image stringVersion Arn - The ARN of the image version created on the instance.
- instance_
type str - The instance type.
- lifecycle_
config_ strarn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker_
image_ strarn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker_
image_ strversion_ arn - The ARN of the image version created on the instance.
- instance
Type String - The instance type.
- lifecycle
Config StringArn - The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
- sagemaker
Image StringArn - The Amazon Resource Name (ARN) of the SageMaker image created on the instance.
- sagemaker
Image StringVersion Arn - The ARN of the image version created on the instance.
Import
SageMaker User Profiles can be imported using the arn, e.g.,
$ pulumi import aws:sagemaker/userProfile:UserProfile test_user_profile arn:aws:sagemaker:us-west-2:123456789012:user-profile/domain-id/profile-name
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
awsTerraform Provider.
published on Tuesday, Mar 10, 2026 by Pulumi
