Skip to content

DomainSettings

Source code in docs_src/capo_sagemaker/types/domain_settings.py
class DomainSettings(TypedDict, closed=True):
    security_group_ids: NotRequired[
        "capo_sagemaker.types.domain_security_group_ids.DomainSecurityGroupIds"
    ]
    """<p>The security groups for the Amazon Virtual Private Cloud that the <code>Domain</code> uses for communication between Domain-level apps and user apps.</p>"""
    r_studio_server_pro_domain_settings: NotRequired[
        "capo_sagemaker.types.r_studio_server_pro_domain_settings.RStudioServerProDomainSettings"
    ]
    """<p>A collection of settings that configure the <code>RStudioServerPro</code> Domain-level app.</p>"""
    execution_role_identity_config: NotRequired[
        "capo_sagemaker.types.execution_role_identity_config.ExecutionRoleIdentityConfig"
    ]
    """<p>The configuration for attaching a SageMaker AI user profile name to the execution role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>.</p>"""
    trusted_identity_propagation_settings: NotRequired[
        "capo_sagemaker.types.trusted_identity_propagation_settings.TrustedIdentityPropagationSettings"
    ]
    """<p>The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.</p>"""
    docker_settings: NotRequired["capo_sagemaker.types.docker_settings.DockerSettings"]
    """<p>A collection of settings that configure the domain's Docker interaction.</p>"""
    amazon_q_settings: NotRequired[
        "capo_sagemaker.types.amazon_q_settings.AmazonQSettings"
    ]
    """<p>A collection of settings that configure the Amazon Q experience within the domain. The <code>AuthMode</code> that you use to create the domain must be <code>SSO</code>.</p>"""
    unified_studio_settings: NotRequired[
        "capo_sagemaker.types.unified_studio_settings.UnifiedStudioSettings"
    ]
    """<p>The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.</p>"""
    ip_address_type: NotRequired["capo_sagemaker.types.ip_address_type.IPAddressType"]
    """<p>The IP address type for the domain. Specify <code>ipv4</code> for IPv4-only connectivity or <code>dualstack</code> for both IPv4 and IPv6 connectivity. When you specify <code>dualstack</code>, the subnet must support IPv6 CIDR blocks. If not specified, defaults to <code>ipv4</code>.</p>"""

amazon_q_settings instance-attribute

amazon_q_settings: NotRequired[AmazonQSettings]

A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.

docker_settings instance-attribute

docker_settings: NotRequired[DockerSettings]

A collection of settings that configure the domain's Docker interaction.

execution_role_identity_config instance-attribute

execution_role_identity_config: NotRequired[ExecutionRoleIdentityConfig]

The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key.

ip_address_type instance-attribute

ip_address_type: NotRequired[IPAddressType]

The IP address type for the domain. Specify ipv4 for IPv4-only connectivity or dualstack for both IPv4 and IPv6 connectivity. When you specify dualstack, the subnet must support IPv6 CIDR blocks. If not specified, defaults to ipv4.

r_studio_server_pro_domain_settings instance-attribute

r_studio_server_pro_domain_settings: NotRequired[RStudioServerProDomainSettings]

A collection of settings that configure the RStudioServerPro Domain-level app.

security_group_ids instance-attribute

security_group_ids: NotRequired[DomainSecurityGroupIds]

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

trusted_identity_propagation_settings instance-attribute

trusted_identity_propagation_settings: NotRequired[TrustedIdentityPropagationSettings]

The Trusted Identity Propagation (TIP) settings for the SageMaker domain. These settings determine how user identities from IAM Identity Center are propagated through the domain to TIP enabled Amazon Web Services services.

unified_studio_settings instance-attribute

unified_studio_settings: NotRequired[UnifiedStudioSettings]

The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.