Domain is the Schema for the Domains API. Provides a SageMaker Domain resource.
Type
CRD
Group
sagemaker.aws.upbound.io
Version
v1beta1
apiVersion: sagemaker.aws.upbound.io/v1beta1
kind: Domain
DomainSpec defines the desired state of Domain
No description provided.
The default space settings. See Default Space Settings below.
The Jupyter server's app settings. See Jupyter Server App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The kernel gateway app settings. See Kernel Gateway App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The security groups for the Amazon Virtual Private Cloud that the space uses for communication.
The default user settings. See Default User Settings below.
The Canvas app settings. See Canvas App Settings below.
The model deployment settings for the SageMaker Canvas application. See Direct Deploy Settings below.
The settings for connecting to an external data source with OAuth. See Identity Provider OAuth Settings below.
The settings for document querying. See Kendra Settings below.
The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
Time series forecast settings for the Canvas app. See Time Series Forecasting Settings below.
The workspace settings for the SageMaker Canvas application. See Workspace Settings below.
The Code Editor application settings. See Code Editor App Settings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio. See Custom File System Config below.
The default EBS storage settings for a private space. See EFS File System Config below.
Reference to a Role in iam to populate executionRole.
Policies for referencing.
Selector for a Role in iam to populate executionRole.
Policies for selection.
The settings for the JupyterLab application. See Jupyter Lab App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The Jupyter server's app settings. See Jupyter Server App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The kernel gateway app settings. See Kernel Gateway App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
Reference to a AppImageConfig in sagemaker to populate appImageConfigName.
Policies for referencing.
Selector for a AppImageConfig in sagemaker to populate appImageConfigName.
Policies for selection.
Reference to a ImageVersion in sagemaker to populate imageName.
Policies for referencing.
Selector for a ImageVersion in sagemaker to populate imageName.
Policies for selection.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The RSession app settings. See RSession App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
A collection of settings that configure user interaction with the RStudioServerPro app. See RStudioServerProAppSettings below.
A list of security group IDs that will be attached to the user.
The sharing settings. See Sharing Settings below.
The storage settings for a private space. See Space Storage Settings below.
The default EBS storage settings for a private space. See Default EBS Storage Settings below.
The TensorBoard app settings. See TensorBoard App Settings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The domain settings. See Domain Settings below.
A collection of settings that configure the RStudioServerPro Domain-level app. see RStudioServerProDomainSettings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
Reference to a Key in kms to populate kmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate kmsKeyId.
Policies for selection.
The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained. See Retention Policy below.
References to Subnet in ec2 to populate subnetIds.
Policies for referencing.
Selector for a list of Subnet in ec2 to populate subnetIds.
Policies for selection.
The VPC subnets that Studio uses for communication.
Reference to a VPC in ec2 to populate vpcId.
Policies for referencing.
Selector for a VPC in ec2 to populate vpcId.
Policies for selection.
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
The default space settings. See Default Space Settings below.
The Jupyter server's app settings. See Jupyter Server App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The kernel gateway app settings. See Kernel Gateway App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The security groups for the Amazon Virtual Private Cloud that the space uses for communication.
The default user settings. See Default User Settings below.
The Canvas app settings. See Canvas App Settings below.
The model deployment settings for the SageMaker Canvas application. See Direct Deploy Settings below.
The settings for connecting to an external data source with OAuth. See Identity Provider OAuth Settings below.
The settings for document querying. See Kendra Settings below.
The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
Time series forecast settings for the Canvas app. See Time Series Forecasting Settings below.
The workspace settings for the SageMaker Canvas application. See Workspace Settings below.
The Code Editor application settings. See Code Editor App Settings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio. See Custom File System Config below.
The default EBS storage settings for a private space. See EFS File System Config below.
Reference to a Role in iam to populate executionRole.
Policies for referencing.
Selector for a Role in iam to populate executionRole.
Policies for selection.
The settings for the JupyterLab application. See Jupyter Lab App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The Jupyter server's app settings. See Jupyter Server App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The kernel gateway app settings. See Kernel Gateway App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
Reference to a AppImageConfig in sagemaker to populate appImageConfigName.
Policies for referencing.
Selector for a AppImageConfig in sagemaker to populate appImageConfigName.
Policies for selection.
Reference to a ImageVersion in sagemaker to populate imageName.
Policies for referencing.
Selector for a ImageVersion in sagemaker to populate imageName.
Policies for selection.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The RSession app settings. See RSession App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
A collection of settings that configure user interaction with the RStudioServerPro app. See RStudioServerProAppSettings below.
A list of security group IDs that will be attached to the user.
The sharing settings. See Sharing Settings below.
The storage settings for a private space. See Space Storage Settings below.
The default EBS storage settings for a private space. See Default EBS Storage Settings below.
The TensorBoard app settings. See TensorBoard App Settings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The domain settings. See Domain Settings below.
A collection of settings that configure the RStudioServerPro Domain-level app. see RStudioServerProDomainSettings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
Reference to a Key in kms to populate kmsKeyId.
Policies for referencing.
Selector for a Key in kms to populate kmsKeyId.
Policies for selection.
The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained. See Retention Policy below.
References to Subnet in ec2 to populate subnetIds.
Policies for referencing.
Selector for a list of Subnet in ec2 to populate subnetIds.
Policies for selection.
The VPC subnets that Studio uses for communication.
Reference to a VPC in ec2 to populate vpcId.
Policies for referencing.
Selector for a VPC in ec2 to populate vpcId.
Policies for selection.
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
DomainStatus defines the observed state of Domain.
No description provided.
The default space settings. See Default Space Settings below.
The Jupyter server's app settings. See Jupyter Server App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The kernel gateway app settings. See Kernel Gateway App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The security groups for the Amazon Virtual Private Cloud that the space uses for communication.
The default user settings. See Default User Settings below.
The Canvas app settings. See Canvas App Settings below.
The model deployment settings for the SageMaker Canvas application. See Direct Deploy Settings below.
The settings for connecting to an external data source with OAuth. See Identity Provider OAuth Settings below.
The settings for document querying. See Kendra Settings below.
The model registry settings for the SageMaker Canvas application. See Model Register Settings below.
Time series forecast settings for the Canvas app. See Time Series Forecasting Settings below.
The workspace settings for the SageMaker Canvas application. See Workspace Settings below.
The Code Editor application settings. See Code Editor App Settings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio. See Custom File System Config below.
The default EBS storage settings for a private space. See EFS File System Config below.
The settings for the JupyterLab application. See Jupyter Lab App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The Jupyter server's app settings. See Jupyter Server App Settings below.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The kernel gateway app settings. See Kernel Gateway App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The Amazon Resource Name (ARN) of the Lifecycle Configurations.
The RSession app settings. See RSession App Settings below.
A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
A collection of settings that configure user interaction with the RStudioServerPro app. See RStudioServerProAppSettings below.
A list of security group IDs that will be attached to the user.
The sharing settings. See Sharing Settings below.
The storage settings for a private space. See Space Storage Settings below.
The default EBS storage settings for a private space. See Default EBS Storage Settings below.
The TensorBoard app settings. See TensorBoard App Settings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The domain settings. See Domain Settings below.
A collection of settings that configure the RStudioServerPro Domain-level app. see RStudioServerProDomainSettings below.
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained. See Retention Policy below.
The VPC subnets that Studio uses for communication.
Conditions of the resource.
example-sage
apiVersion: sagemaker.aws.upbound.io/v1beta1
kind: Domain
metadata:
annotations:
meta.upbound.io/example-id: sagemaker/v1beta1/space
upjet.upbound.io/manual-intervention: Require executionRole arn to be manually specified.
labels:
testing.upbound.io/example-name: example-sage
name: example-sage
spec:
forProvider:
authMode: IAM
defaultSpaceSettings:
- executionRole: arn:aws:iam::153891904029:role/example-sage-role
defaultUserSettings:
- executionRoleSelector:
matchLabels:
testing.upbound.io/example-name: example-sage-role
domainName: example
region: us-west-1
retentionPolicy:
- homeEfsFileSystem: Delete
subnetIdRefs:
- name: sample-subnet1-sage
vpcIdSelector:
matchLabels:
testing.upbound.io/example-name: sample-vpc-sage
example-domain
apiVersion: sagemaker.aws.upbound.io/v1beta1
kind: Domain
metadata:
annotations:
meta.upbound.io/example-id: sagemaker/v1beta1/userprofile
labels:
testing.upbound.io/example-name: example-domain
name: example-domain
spec:
forProvider:
authMode: IAM
defaultUserSettings:
- executionRoleSelector:
matchLabels:
testing.upbound.io/example-name: example
domainName: example
region: us-east-1
retentionPolicy:
- homeEfsFileSystem: Delete
subnetIdRefs:
- name: sample-subnet-sage
vpcIdSelector:
matchLabels:
testing.upbound.io/example-name: sample-vpc-sage
example-domain
apiVersion: sagemaker.aws.upbound.io/v1beta1
kind: Domain
metadata:
annotations:
meta.upbound.io/example-id: sagemaker/v1beta1/app
labels:
testing.upbound.io/example-name: example-domain
name: example-domain
spec:
forProvider:
authMode: IAM
defaultUserSettings:
- executionRoleSelector:
matchLabels:
testing.upbound.io/example-name: example
domainName: example
region: us-east-1
retentionPolicy:
- homeEfsFileSystem: Delete
subnetIdRefs:
- name: sample-subnet-sage
vpcIdSelector:
matchLabels:
testing.upbound.io/example-name: sample-vpc-sage
example-sage
apiVersion: sagemaker.aws.upbound.io/v1beta1
kind: Domain
metadata:
annotations:
meta.upbound.io/example-id: sagemaker/v1beta1/domain
labels:
testing.upbound.io/example-name: example-sage
name: example-sage
spec:
forProvider:
authMode: IAM
defaultUserSettings:
- executionRoleSelector:
matchLabels:
testing.upbound.io/example-name: example-sage-role
domainName: example
region: us-west-1
retentionPolicy:
- homeEfsFileSystem: Delete
subnetIdRefs:
- name: sample-subnet1-sage
vpcIdSelector:
matchLabels:
testing.upbound.io/example-name: sample-vpc-sage
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.