Package software.amazon.awscdk.services.sagemaker

Interface CfnDomain.DomainSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.DomainSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.DomainSettingsProperty
extends software.amazon.jsii.JsiiSerializable

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 DomainSettingsProperty domainSettingsProperty = DomainSettingsProperty.builder()
         .dockerSettings(DockerSettingsProperty.builder()
                 .enableDockerAccess("enableDockerAccess")
                 .vpcOnlyTrustedAccounts(List.of("vpcOnlyTrustedAccounts"))
                 .build())
         .executionRoleIdentityConfig("executionRoleIdentityConfig")
         .ipAddressType("ipAddressType")
         .rStudioServerProDomainSettings(RStudioServerProDomainSettingsProperty.builder()
                 .domainExecutionRoleArn("domainExecutionRoleArn")
                 // the properties below are optional
                 .defaultResourceSpec(ResourceSpecProperty.builder()
                         .instanceType("instanceType")
                         .lifecycleConfigArn("lifecycleConfigArn")
                         .sageMakerImageArn("sageMakerImageArn")
                         .sageMakerImageVersionArn("sageMakerImageVersionArn")
                         .build())
                 .rStudioConnectUrl("rStudioConnectUrl")
                 .rStudioPackageManagerUrl("rStudioPackageManagerUrl")
                 .build())
         .securityGroupIds(List.of("securityGroupIds"))
         .unifiedStudioSettings(UnifiedStudioSettingsProperty.builder()
                 .domainAccountId("domainAccountId")
                 .domainId("domainId")
                 .domainRegion("domainRegion")
                 .environmentId("environmentId")
                 .projectId("projectId")
                 .projectS3Path("projectS3Path")
                 .studioWebPortalAccess("studioWebPortalAccess")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.DomainSettingsProperty.Builder	A builder for CfnDomain.DomainSettingsProperty
static final class	CfnDomain.DomainSettingsProperty.Jsii$Proxy	An implementation for CfnDomain.DomainSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.DomainSettingsProperty.Builder	builder()
default Object	getDockerSettings()	A collection of settings that configure the domain's Docker interaction.
default String	getExecutionRoleIdentityConfig()	The configuration for attaching a SageMaker AI user profile name to the execution role as a sts:SourceIdentity key .
default String	getIpAddressType()	The IP address type for the domain.
default Object	getRStudioServerProDomainSettings()	A collection of settings that configure the RStudioServerPro Domain-level app.
default List<String>	getSecurityGroupIds()	The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.
default Object	getUnifiedStudioSettings()	The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDockerSettings

@Stability(Stable)
@Nullable
default Object getDockerSettings()

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

Returns union: either IResolvable or CfnDomain.DockerSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-dockersettings

getExecutionRoleIdentityConfig

@Stability(Stable)
@Nullable
default String getExecutionRoleIdentityConfig()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-executionroleidentityconfig

getIpAddressType

@Stability(Stable)
@Nullable
default String getIpAddressType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-ipaddresstype

getRStudioServerProDomainSettings

@Stability(Stable)
@Nullable
default Object getRStudioServerProDomainSettings()

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

Returns union: either IResolvable or CfnDomain.RStudioServerProDomainSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-rstudioserverprodomainsettings

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-securitygroupids

getUnifiedStudioSettings

@Stability(Stable)
@Nullable
default Object getUnifiedStudioSettings()

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

Returns union: either IResolvable or CfnDomain.UnifiedStudioSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html#cfn-sagemaker-domain-domainsettings-unifiedstudiosettings

builder

@Stability(Stable)
static CfnDomain.DomainSettingsProperty.Builder builder()

Returns:

a CfnDomain.DomainSettingsProperty.Builder of CfnDomain.DomainSettingsProperty