CreateDomainRequest ¶

class CreateDomainRequest(TypedDict, closed=True):
    domain_name: NotRequired["capo_sagemaker.types.domain_name.DomainName"]
    """<p>A name for the domain.</p>"""
    auth_mode: NotRequired["capo_sagemaker.types.auth_mode.AuthMode"]
    """<p>The mode of authentication that members use to access the domain.</p>"""
    default_user_settings: NotRequired[
        "capo_sagemaker.types.user_settings.UserSettings"
    ]
    """<p>The default settings to use to create a user profile when <code>UserSettings</code> isn't specified in the call to the <code>CreateUserProfile</code> API.</p> <p> <code>SecurityGroups</code> is aggregated when specified in both calls. For all other settings in <code>UserSettings</code>, the values specified in <code>CreateUserProfile</code> take precedence over those specified in <code>CreateDomain</code>.</p>"""
    domain_settings: NotRequired["capo_sagemaker.types.domain_settings.DomainSettings"]
    """<p>A collection of <code>Domain</code> settings.</p>"""
    subnet_ids: NotRequired["capo_sagemaker.types.subnets.Subnets"]
    """<p>The VPC subnets that the domain uses for communication.</p> <p>The field is optional when the <code>AppNetworkAccessType</code> parameter is set to <code>PublicInternetOnly</code> for domains created from Amazon SageMaker Unified Studio.</p>"""
    vpc_id: NotRequired["capo_sagemaker.types.vpc_id.VpcId"]
    """<p>The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.</p> <p>The field is optional when the <code>AppNetworkAccessType</code> parameter is set to <code>PublicInternetOnly</code> for domains created from Amazon SageMaker Unified Studio.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the <code>Search</code> API.</p> <p>Tags that you specify for the Domain are also added to all Apps that the Domain launches.</p>"""
    app_network_access_type: NotRequired[
        "capo_sagemaker.types.app_network_access_type.AppNetworkAccessType"
    ]
    """<p>Specifies the VPC used for non-EFS traffic. The default value is <code>PublicInternetOnly</code>.</p> <ul> <li> <p> <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker AI, which allows direct internet access</p> </li> <li> <p> <code>VpcOnly</code> - All traffic is through the specified VPC and subnets</p> </li> </ul>"""
    home_efs_file_system_kms_key_id: NotRequired[
        "capo_sagemaker.types.kms_key_id.KmsKeyId"
    ]
    """<p>Use <code>KmsKeyId</code>.</p>"""
    kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>SageMaker AI uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.</p>"""
    app_security_group_management: NotRequired[
        "capo_sagemaker.types.app_security_group_management.AppSecurityGroupManagement"
    ]
    """<p>The entity that creates and manages the required security groups for inter-app communication in <code>VPCOnly</code> mode. Required when <code>CreateDomain.AppNetworkAccessType</code> is <code>VPCOnly</code> and <code>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</code> is provided. If setting up the domain for use with RStudio, this value must be set to <code>Service</code>.</p>"""
    home_efs_file_system_creation: NotRequired[
        "capo_sagemaker.types.home_efs_file_system_creation.HomeEfsFileSystemCreation"
    ]
    """<p>Indicates whether to create a home EFS file system for the domain. Defaults to <code>Enabled</code>. Set to <code>Disabled</code> to skip EFS creation and reduce domain creation time. You can enable EFS later by calling <code>UpdateDomain</code>.</p>"""
    tag_propagation: NotRequired["capo_sagemaker.types.tag_propagation.TagPropagation"]
    """<p>Indicates whether custom tag propagation is supported for the domain. Defaults to <code>DISABLED</code>.</p>"""
    default_space_settings: NotRequired[
        "capo_sagemaker.types.default_space_settings.DefaultSpaceSettings"
    ]
    """<p>The default settings for shared spaces that users create in the domain.</p>"""