Provides a SageMaker Space resource.
resource "aws_sagemaker_space" "example" {
domain_id = aws_sagemaker_domain.test.id
space_name = "example"
}
This resource supports the following arguments:
domain_id
- (Required) The ID of the associated Domain.ownership_settings
- (Optional) A collection of ownership settings. See Ownership Settings below.space_display_name
- (Optional) The name of the space that appears in the SageMaker Studio UI.space_name
- (Required) The name of the space.space_settings
- (Required) A collection of space settings. See Space Settings below.space_sharing_settings
- (Optional) A collection of space sharing settings. See Space Sharing Settings below.tags
- (Optional) A map of tags to assign to the resource. If configured with a provider default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.owner_user_profile_name
- (Required) The user profile who is the owner of the private space.sharing_type
- (Required) Specifies the sharing type of the space. Valid values are Private
and Shared
.app_type
- (Optional) The type of app created within the space.code_editor_app_settings
- (Optional) The Code Editor application settings. See Code Editor App Settings below.custom_file_system
- (Optional) A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. See Custom File System below.jupyter_lab_app_settings
- (Optional) The settings for the JupyterLab application. See Jupyter Lab App Settings below.jupyter_server_app_settings
- (Optional) The Jupyter server's app settings. See Jupyter Server App Settings below.kernel_gateway_app_settings
- (Optional) The kernel gateway app settings. See Kernel Gateway App Settings below.default_resource_spec
- (Optional) 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_arns
- (Optional) The Amazon Resource Name (ARN) of the Lifecycle Configurations.efs_file_system
- (Optional) A custom file system in Amazon EFS. see EFS File System below.code_repository
- (Optional) A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.default_resource_spec
- (Optional) 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_arns
- (Optional) The Amazon Resource Name (ARN) of the Lifecycle Configurations.default_resource_spec
- (Optional) The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. see Default Resource Spec below.custom_image
- (Optional) A list of custom SageMaker images that are configured to run as a KernelGateway app. see Custom Image below.lifecycle_config_arns
- (Optional) The Amazon Resource Name (ARN) of the Lifecycle Configurations.code_repository
- (Optional) A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application. see Code Repository below.default_resource_spec
- (Optional) 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_arns
- (Optional) The Amazon Resource Name (ARN) of the Lifecycle Configurations.file_system_id
- (Optional) The ID of your Amazon EFS file system.repository_url
- (Optional) The URL of the Git repository.instance_type
- (Optional) The instance type.lifecycle_config_arn
- (Optional) The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.sagemaker_image_arn
- (Optional) The Amazon Resource Name (ARN) of the SageMaker image created on the instance.sagemaker_image_version_alias
- (Optional) The SageMaker Image Version Alias.sagemaker_image_version_arn
- (Optional) The ARN of the image version created on the instance.app_image_config_name
- (Required) The name of the App Image Config.image_name
- (Required) The name of the Custom Image.image_version_number
- (Optional) The version number of the Custom Image.This resource exports the following attributes in addition to the arguments above:
arn
- The space's Amazon Resource Name (ARN).home_efs_file_system_uid
- The ID of the space's profile in the Amazon Elastic File System volume.id
- The space's Amazon Resource Name (ARN).tags_all
- A map of tags assigned to the resource, including those inherited from the provider default_tags
configuration block.url
- Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.In Terraform v1.5.0 and later, use an import
block to import SageMaker Spaces using the id
. For example:
import {
to = aws_sagemaker_space.test_space
id = "arn:aws:sagemaker:us-west-2:123456789012:space/domain-id/space-name"
}
Using terraform import
, import SageMaker Spaces using the id
. For example:
% terraform import aws_sagemaker_space.test_space arn:aws:sagemaker:us-west-2:123456789012:space/domain-id/space-name