Package software.amazon.awscdk.services.sagemaker

Class CfnDomain.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnDomain.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomain>

Enclosing class:

CfnDomain

@Stability(Stable)
public static final class CfnDomain.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomain>

A fluent builder for CfnDomain.

Method Summary

Modifier and Type	Method	Description
CfnDomain.Builder	appNetworkAccessType(String appNetworkAccessType)	Specifies the VPC used for non-EFS traffic.
CfnDomain.Builder	appSecurityGroupManagement(String appSecurityGroupManagement)	The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.
CfnDomain.Builder	authMode(String authMode)	The mode of authentication that members use to access the Domain.
CfnDomain	build()
static CfnDomain.Builder	create(software.constructs.Construct scope, String id)
CfnDomain.Builder	defaultSpaceSettings(IResolvable defaultSpaceSettings)	The default settings for shared spaces that users create in the domain.
CfnDomain.Builder	defaultSpaceSettings(CfnDomain.DefaultSpaceSettingsProperty defaultSpaceSettings)	The default settings for shared spaces that users create in the domain.
CfnDomain.Builder	defaultUserSettings(IResolvable defaultUserSettings)	The default user settings.
CfnDomain.Builder	defaultUserSettings(CfnDomain.UserSettingsProperty defaultUserSettings)	The default user settings.
CfnDomain.Builder	domainName(String domainName)	The domain name.
CfnDomain.Builder	domainSettings(IResolvable domainSettings)	A collection of settings that apply to the SageMaker Domain .
CfnDomain.Builder	domainSettings(CfnDomain.DomainSettingsProperty domainSettings)	A collection of settings that apply to the SageMaker Domain .
CfnDomain.Builder	kmsKeyId(String kmsKeyId)	SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.
CfnDomain.Builder	subnetIds(List<String> subnetIds)	The VPC subnets that Studio uses for communication.
CfnDomain.Builder	tagPropagation(String tagPropagation)	Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
CfnDomain.Builder	tags(List<? extends CfnTag> tags)	Tags to associated with the Domain.
CfnDomain.Builder	vpcId(String vpcId)	The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDomain.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDomain.Builder.

authMode

@Stability(Stable)
public CfnDomain.Builder authMode(String authMode)

The mode of authentication that members use to access the Domain.

Valid Values : SSO | IAM

Parameters:

authMode - The mode of authentication that members use to access the Domain. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-authmode

defaultUserSettings

@Stability(Stable)
public CfnDomain.Builder defaultUserSettings(IResolvable defaultUserSettings)

The default user settings.

Parameters:

defaultUserSettings - The default user settings. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultusersettings

defaultUserSettings

@Stability(Stable)
public CfnDomain.Builder defaultUserSettings(CfnDomain.UserSettingsProperty defaultUserSettings)

The default user settings.

Parameters:

defaultUserSettings - The default user settings. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultusersettings

domainName

@Stability(Stable)
public CfnDomain.Builder domainName(String domainName)

The domain name.

Parameters:

domainName - The domain name. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-domainname

subnetIds

@Stability(Stable)
public CfnDomain.Builder subnetIds(List<String> subnetIds)

The VPC subnets that Studio uses for communication.

Length Constraints : Maximum length of 32.

Array members : Minimum number of 1 item. Maximum number of 16 items.

Pattern : [-0-9a-zA-Z]+

Parameters:

subnetIds - The VPC subnets that Studio uses for communication. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-subnetids

vpcId

@Stability(Stable)
public CfnDomain.Builder vpcId(String vpcId)

The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.

Length Constraints : Maximum length of 32.

Pattern : [-0-9a-zA-Z]+

Parameters:

vpcId - The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-vpcid

appNetworkAccessType

@Stability(Stable)
public CfnDomain.Builder appNetworkAccessType(String appNetworkAccessType)

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker , which allows direct internet access
• VpcOnly - All Studio traffic is through the specified VPC and subnets

Valid Values : PublicInternetOnly | VpcOnly

Parameters:

appNetworkAccessType - Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-appnetworkaccesstype

appSecurityGroupManagement

@Stability(Stable)
public CfnDomain.Builder appSecurityGroupManagement(String appSecurityGroupManagement)

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. If setting up the domain for use with RStudio, this value must be set to Service .

Allowed Values : Service | Customer

Parameters:

appSecurityGroupManagement - The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-appsecuritygroupmanagement

defaultSpaceSettings

@Stability(Stable)
public CfnDomain.Builder defaultSpaceSettings(IResolvable defaultSpaceSettings)

The default settings for shared spaces that users create in the domain.

SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.

Parameters:

defaultSpaceSettings - The default settings for shared spaces that users create in the domain. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultspacesettings

defaultSpaceSettings

@Stability(Stable)
public CfnDomain.Builder defaultSpaceSettings(CfnDomain.DefaultSpaceSettingsProperty defaultSpaceSettings)

The default settings for shared spaces that users create in the domain.

SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.

Parameters:

defaultSpaceSettings - The default settings for shared spaces that users create in the domain. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-defaultspacesettings

domainSettings

@Stability(Stable)
public CfnDomain.Builder domainSettings(IResolvable domainSettings)

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

Parameters:

domainSettings - A collection of settings that apply to the SageMaker Domain . This parameter is required.

Returns:

this

See Also:

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

domainSettings

@Stability(Stable)
public CfnDomain.Builder domainSettings(CfnDomain.DomainSettingsProperty domainSettings)

A collection of settings that apply to the SageMaker Domain .

These settings are specified through the CreateDomain API call.

Parameters:

domainSettings - A collection of settings that apply to the SageMaker Domain . This parameter is required.

Returns:

this

See Also:

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

kmsKeyId

@Stability(Stable)
public CfnDomain.Builder kmsKeyId(String kmsKeyId)

SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.

For more control, specify a customer managed CMK.

Length Constraints : Maximum length of 2048.

Pattern : .*

Parameters:

kmsKeyId - SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-kmskeyid

tagPropagation

@Stability(Stable)
public CfnDomain.Builder tagPropagation(String tagPropagation)

Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.

Parameters:

tagPropagation - Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-tagpropagation

tags

@Stability(Stable)
public CfnDomain.Builder tags(List<? extends CfnTag> tags)

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 Search API.

Tags that you specify for the Domain are also added to all apps that are launched in the Domain.

Array members : Minimum number of 0 items. Maximum number of 50 items.

Parameters:

tags - Tags to associated with the Domain. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-domain.html#cfn-sagemaker-domain-tags

build

@Stability(Stable)
public CfnDomain build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomain>

Returns:

a newly built instance of CfnDomain.