UserProfile
sagemaker.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | sagemaker-controller/apis/v1alpha1#UserProfile |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | UserProfile |
ListKind | UserProfileList |
Plural | userprofiles |
Singular | userprofile |
Spec
domainID: string
singleSignOnUserIdentifier: string
singleSignOnUserValue: string
tags:
- key: string
value: string
userProfileName: string
userSettings:
executionRole: string
jupyterServerAppSettings:
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
lifecycleConfigARNs:
- string
kernelGatewayAppSettings:
customImages:
- appImageConfigName: string
imageName: string
imageVersionNumber: integer
defaultResourceSpec:
instanceType: string
lifecycleConfigARN: string
sageMakerImageARN: string
sageMakerImageVersionARN: string
lifecycleConfigARNs:
- 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
Field | Description |
---|---|
domainID Required | string The ID of the associated Domain. |
singleSignOnUserIdentifier Optional | string A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is “UserName”. If the Domain’s AuthMode is IAM Identity Center, this field is required. If the Domain’s AuthMode is not IAM Identity Center, this field cannot be specified. |
singleSignOnUserValue Optional | string The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain’s AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain’s AuthMode is not IAM Identity Center, this field cannot be specified. |
tags Optional | array Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags that you specify for the User Profile are also added to all Apps that the User Profile launches. |
tags.[] Required | object A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources. |
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags. | |
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). | |
tags.[].value Optional | string |
userProfileName Required | string A name for the UserProfile. This value is not case sensitive. |
userSettings Optional | object A collection of settings. |
userSettings.executionRole Optional | string |
userSettings.jupyterServerAppSettings Optional | object The JupyterServer app settings. |
userSettings.jupyterServerAppSettings.defaultResourceSpec Optional | object Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on. |
userSettings.jupyterServerAppSettings.defaultResourceSpec.instanceType Optional | string |
userSettings.jupyterServerAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
userSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
userSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
userSettings.jupyterServerAppSettings.lifecycleConfigARNs Optional | array |
userSettings.jupyterServerAppSettings.lifecycleConfigARNs.[] Required | string |
userSettings.kernelGatewayAppSettings.customImages Optional | array |
userSettings.kernelGatewayAppSettings.customImages.[] Required | object A custom SageMaker image. For more information, see Bring your own SageMaker image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). |
userSettings.kernelGatewayAppSettings.customImages.[].imageName Optional | string |
userSettings.kernelGatewayAppSettings.customImages.[].imageVersionNumber Optional | integer |
userSettings.kernelGatewayAppSettings.defaultResourceSpec Optional | object Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on. |
userSettings.kernelGatewayAppSettings.defaultResourceSpec.instanceType Optional | string |
userSettings.kernelGatewayAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
userSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
userSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
userSettings.kernelGatewayAppSettings.lifecycleConfigARNs Optional | array |
userSettings.kernelGatewayAppSettings.lifecycleConfigARNs.[] Required | string |
userSettings.rStudioServerProAppSettings.accessStatus Optional | string |
userSettings.rStudioServerProAppSettings.userGroup Optional | string |
userSettings.securityGroups Optional | array |
userSettings.securityGroups.[] Required | string |
userSettings.sharingSettings.notebookOutputOption Optional | string |
userSettings.sharingSettings.s3KMSKeyID Optional | string |
userSettings.sharingSettings.s3OutputPath Optional | string |
userSettings.tensorBoardAppSettings Optional | object The TensorBoard app settings. |
userSettings.tensorBoardAppSettings.defaultResourceSpec Optional | object Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on. |
userSettings.tensorBoardAppSettings.defaultResourceSpec.instanceType Optional | string |
userSettings.tensorBoardAppSettings.defaultResourceSpec.lifecycleConfigARN Optional | string |
userSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageARN Optional | string |
userSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionARN Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
status: string
Field | Description |
---|---|
ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource |
ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
conditions Optional | array All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource |
conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource |
conditions.[].message Optional | string A human readable message indicating details about the transition. |
conditions.[].reason Optional | string The reason for the condition’s last transition. |
conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
conditions.[].type Optional | string Type is the type of the Condition |
status Optional | string The status. |