Resource Type definition for AWS::SageMaker::Domain
auth_mode
(String) The mode of authentication that members use to access the domain.default_user_settings
(Attributes) The default user settings. (see below for nested schema)domain_name
(String) A name for the domain.subnet_ids
(List of String) The VPC subnets that Studio uses for communication.vpc_id
(String) The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.app_network_access_type
(String) Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.app_security_group_management
(String) The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.default_space_settings
(Attributes) The default space settings. (see below for nested schema)domain_settings
(Attributes) A collection of Domain settings. (see below for nested schema)kms_key_id
(String) SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default.tags
(Attributes List) A list of tags to apply to the user profile. (see below for nested schema)domain_arn
(String) The Amazon Resource Name (ARN) of the created domain.domain_id
(String) The domain name.home_efs_file_system_id
(String) The ID of the Amazon Elastic File System (EFS) managed by this Domain.id
(String) Uniquely identifies the resource.security_group_id_for_domain_boundary
(String) The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.single_sign_on_application_arn
(String) The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.single_sign_on_managed_application_instance_id
(String) The SSO managed application instance ID.url
(String) The URL to the created domain.default_user_settings
Required:
execution_role
(String) The execution role for the user.Optional:
code_editor_app_settings
(Attributes) The CodeEditor app settings. (see below for nested schema)custom_file_system_configs
(Attributes List) (see below for nested schema)custom_posix_user_config
(Attributes) (see below for nested schema)default_landing_uri
(String) Defines which Amazon SageMaker application users are directed to by default.jupyter_lab_app_settings
(Attributes) The JupyterLab app settings. (see below for nested schema)jupyter_server_app_settings
(Attributes) The Jupyter server's app settings. (see below for nested schema)kernel_gateway_app_settings
(Attributes) The kernel gateway app settings. (see below for nested schema)r_session_app_settings
(Attributes) A collection of settings that apply to an RSessionGateway app. (see below for nested schema)r_studio_server_pro_app_settings
(Attributes) A collection of settings that configure user interaction with the RStudioServerPro app. (see below for nested schema)security_groups
(List of String) The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.sharing_settings
(Attributes) The sharing settings. (see below for nested schema)space_storage_settings
(Attributes) Default storage settings for a space. (see below for nested schema)studio_web_portal
(String) Indicates whether the Studio experience is available to users. If not, users cannot access Studio.default_user_settings.code_editor_app_settings
Optional:
custom_images
(Attributes List) A list of custom images for use for CodeEditor apps. (see below for nested schema)default_resource_spec
(Attributes) The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the CodeEditor app. (see below for nested schema)lifecycle_config_arns
(List of String) A list of LifecycleConfigArns available for use with CodeEditor apps.default_user_settings.code_editor_app_settings.custom_images
Required:
app_image_config_name
(String) The Name of the AppImageConfig.image_name
(String) The name of the CustomImage. Must be unique to your account.Optional:
image_version_number
(Number) The version number of the CustomImage.default_user_settings.code_editor_app_settings.default_resource_spec
Optional:
instance_type
(String) The instance type that the image version runs on.lifecycle_config_arn
(String) The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.sage_maker_image_arn
(String) The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.sage_maker_image_version_arn
(String) The Amazon Resource Name (ARN) of the image version created on the instance.default_user_settings.custom_file_system_configs
Optional:
efs_file_system_config
(Attributes) (see below for nested schema)default_user_settings.custom_file_system_configs.efs_file_system_config
Required:
file_system_id
(String)Optional:
file_system_path
(String)default_user_settings.custom_posix_user_config
Required:
gid
(Number)uid
(Number)default_user_settings.jupyter_lab_app_settings
Optional:
code_repositories
(Attributes List) A list of CodeRepositories available for use with JupyterLab apps. (see below for nested schema)custom_images
(Attributes List) A list of custom images for use for JupyterLab apps. (see below for nested schema)default_resource_spec
(Attributes) The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterLab app. (see below for nested schema)lifecycle_config_arns
(List of String) A list of LifecycleConfigArns available for use with JupyterLab apps.default_user_settings.jupyter_lab_app_settings.code_repositories
Required:
repository_url
(String) A CodeRepository (valid URL) to be used within Jupyter's Git extension.default_user_settings.jupyter_lab_app_settings.custom_images
Required:
app_image_config_name
(String) The Name of the AppImageConfig.image_name
(String) The name of the CustomImage. Must be unique to your account.Optional:
image_version_number
(Number) The version number of the CustomImage.default_user_settings.jupyter_lab_app_settings.default_resource_spec
Optional:
instance_type
(String) The instance type that the image version runs on.lifecycle_config_arn
(String) The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.sage_maker_image_arn
(String) The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.sage_maker_image_version_arn
(String) The Amazon Resource Name (ARN) of the image version created on the instance.default_user_settings.jupyter_server_app_settings
Optional:
default_resource_spec
(Attributes) (see below for nested schema)default_user_settings.jupyter_server_app_settings.default_resource_spec
Optional:
instance_type
(String) The instance type that the image version runs on.lifecycle_config_arn
(String) The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.sage_maker_image_arn
(String) The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.sage_maker_image_version_arn
(String) The Amazon Resource Name (ARN) of the image version created on the instance.default_user_settings.kernel_gateway_app_settings
Optional:
custom_images
(Attributes List) A list of custom SageMaker images that are configured to run as a KernelGateway app. (see below for nested schema)default_resource_spec
(Attributes) The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. (see below for nested schema)default_user_settings.kernel_gateway_app_settings.custom_images
Required:
app_image_config_name
(String) The Name of the AppImageConfig.image_name
(String) The name of the CustomImage. Must be unique to your account.Optional:
image_version_number
(Number) The version number of the CustomImage.default_user_settings.kernel_gateway_app_settings.default_resource_spec
Optional:
instance_type
(String) The instance type that the image version runs on.lifecycle_config_arn
(String) The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.sage_maker_image_arn
(String) The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.sage_maker_image_version_arn
(String) The Amazon Resource Name (ARN) of the image version created on the instance.default_user_settings.r_session_app_settings
Optional:
custom_images
(Attributes List) A list of custom SageMaker images that are configured to run as a KernelGateway app. (see below for nested schema)default_resource_spec
(Attributes) (see below for nested schema)default_user_settings.r_session_app_settings.custom_images
Required:
app_image_config_name
(String) The Name of the AppImageConfig.image_name
(String) The name of the CustomImage. Must be unique to your account.Optional:
image_version_number
(Number) The version number of the CustomImage.default_user_settings.r_session_app_settings.default_resource_spec
Optional:
instance_type
(String) The instance type that the image version runs on.lifecycle_config_arn
(String) The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.sage_maker_image_arn
(String) The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.sage_maker_image_version_arn
(String) The Amazon Resource Name (ARN) of the image version created on the instance.default_user_settings.r_studio_server_pro_app_settings
Optional:
access_status
(String) Indicates whether the current user has access to the RStudioServerPro app.user_group
(String) The level of permissions that the user has within the RStudioServerPro app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.default_user_settings.sharing_settings
Optional:
notebook_output_option
(String) Whether to include the notebook cell output when sharing the notebook. The default is Disabled.s3_kms_key_id
(String) When NotebookOutputOption is Allowed, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.s3_output_path
(String) When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.default_user_settings.space_storage_settings
Optional:
default_ebs_storage_settings
(Attributes) Properties related to the Amazon Elastic Block Store volume. Must be provided if storage type is Amazon EBS and must not be provided if storage type is not Amazon EBS (see below for nested schema)default_user_settings.space_storage_settings.default_ebs_storage_settings
Required:
default_ebs_volume_size_in_gb
(Number) Default size of the Amazon EBS volume in Gbmaximum_ebs_volume_size_in_gb
(Number) Maximum size of the Amazon EBS volume in Gb. Must be greater than or equal to the DefaultEbsVolumeSizeInGb.default_space_settings
Required:
execution_role
(String) The execution role for the space.Optional:
jupyter_server_app_settings
(Attributes) The Jupyter server's app settings. (see below for nested schema)kernel_gateway_app_settings
(Attributes) The kernel gateway app settings. (see below for nested schema)security_groups
(List of String) The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.default_space_settings.jupyter_server_app_settings
Optional:
default_resource_spec
(Attributes) (see below for nested schema)default_space_settings.jupyter_server_app_settings.default_resource_spec
Optional:
instance_type
(String) The instance type that the image version runs on.lifecycle_config_arn
(String) The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.sage_maker_image_arn
(String) The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.sage_maker_image_version_arn
(String) The Amazon Resource Name (ARN) of the image version created on the instance.default_space_settings.kernel_gateway_app_settings
Optional:
custom_images
(Attributes List) A list of custom SageMaker images that are configured to run as a KernelGateway app. (see below for nested schema)default_resource_spec
(Attributes) The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. (see below for nested schema)default_space_settings.kernel_gateway_app_settings.custom_images
Required:
app_image_config_name
(String) The Name of the AppImageConfig.image_name
(String) The name of the CustomImage. Must be unique to your account.Optional:
image_version_number
(Number) The version number of the CustomImage.default_space_settings.kernel_gateway_app_settings.default_resource_spec
Optional:
instance_type
(String) The instance type that the image version runs on.lifecycle_config_arn
(String) The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.sage_maker_image_arn
(String) The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.sage_maker_image_version_arn
(String) The Amazon Resource Name (ARN) of the image version created on the instance.domain_settings
Optional:
docker_settings
(Attributes) A collection of settings that are required to start docker-proxy server. (see below for nested schema)r_studio_server_pro_domain_settings
(Attributes) A collection of settings that update the current configuration for the RStudioServerPro Domain-level app. (see below for nested schema)security_group_ids
(List of String) The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.domain_settings.docker_settings
Optional:
enable_docker_access
(String) The flag to enable/disable docker-proxy servervpc_only_trusted_accounts
(List of String) A list of account id's that would be used to pull images from in VpcOnly modedomain_settings.r_studio_server_pro_domain_settings
Required:
domain_execution_role_arn
(String) The ARN of the execution role for the RStudioServerPro Domain-level app.Optional:
default_resource_spec
(Attributes) (see below for nested schema)r_studio_connect_url
(String) A URL pointing to an RStudio Connect server.r_studio_package_manager_url
(String) A URL pointing to an RStudio Package Manager server.domain_settings.r_studio_server_pro_domain_settings.default_resource_spec
Optional:
instance_type
(String) The instance type that the image version runs on.lifecycle_config_arn
(String) The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.sage_maker_image_arn
(String) The Amazon Resource Name (ARN) of the SageMaker image that the image version belongs to.sage_maker_image_version_arn
(String) The Amazon Resource Name (ARN) of the image version created on the instance.tags
Required:
key
(String)value
(String)Import is supported using the following syntax:
$ terraform import awscc_sagemaker_domain.example <resource ID>