Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnDomainMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnDomainMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomainMixinProps>

Enclosing interface:

CfnDomainMixinProps

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

A builder for CfnDomainMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomainMixinProps.Builder	appNetworkAccessType(String appNetworkAccessType)	Sets the value of CfnDomainMixinProps.getAppNetworkAccessType()
CfnDomainMixinProps.Builder	appSecurityGroupManagement(String appSecurityGroupManagement)	Sets the value of CfnDomainMixinProps.getAppSecurityGroupManagement()
CfnDomainMixinProps.Builder	authMode(String authMode)	Sets the value of CfnDomainMixinProps.getAuthMode()
CfnDomainMixinProps	build()	Builds the configured instance.
CfnDomainMixinProps.Builder	defaultSpaceSettings(CfnDomainPropsMixin.DefaultSpaceSettingsProperty defaultSpaceSettings)	Sets the value of CfnDomainMixinProps.getDefaultSpaceSettings()
CfnDomainMixinProps.Builder	defaultSpaceSettings(IResolvable defaultSpaceSettings)	Sets the value of CfnDomainMixinProps.getDefaultSpaceSettings()
CfnDomainMixinProps.Builder	defaultUserSettings(CfnDomainPropsMixin.UserSettingsProperty defaultUserSettings)	Sets the value of CfnDomainMixinProps.getDefaultUserSettings()
CfnDomainMixinProps.Builder	defaultUserSettings(IResolvable defaultUserSettings)	Sets the value of CfnDomainMixinProps.getDefaultUserSettings()
CfnDomainMixinProps.Builder	domainName(String domainName)	Sets the value of CfnDomainMixinProps.getDomainName()
CfnDomainMixinProps.Builder	domainSettings(CfnDomainPropsMixin.DomainSettingsProperty domainSettings)	Sets the value of CfnDomainMixinProps.getDomainSettings()
CfnDomainMixinProps.Builder	domainSettings(IResolvable domainSettings)	Sets the value of CfnDomainMixinProps.getDomainSettings()
CfnDomainMixinProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnDomainMixinProps.getKmsKeyId()
CfnDomainMixinProps.Builder	subnetIds(List<? extends Object> subnetIds)	Sets the value of CfnDomainMixinProps.getSubnetIds()
CfnDomainMixinProps.Builder	tagPropagation(String tagPropagation)	Sets the value of CfnDomainMixinProps.getTagPropagation()
CfnDomainMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDomainMixinProps.getTags()
CfnDomainMixinProps.Builder	vpcId(String vpcId)	Sets the value of CfnDomainMixinProps.getVpcId()
CfnDomainMixinProps.Builder	vpcId(IVPCRef vpcId)	Sets the value of CfnDomainMixinProps.getVpcId()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

appNetworkAccessType

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

Sets the value of CfnDomainMixinProps.getAppNetworkAccessType()

Parameters:

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 AI , which allows direct internet access
• VpcOnly - All Studio traffic is through the specified VPC and subnets

Valid Values : PublicInternetOnly | VpcOnly

Returns:

this

appSecurityGroupManagement

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

Sets the value of CfnDomainMixinProps.getAppSecurityGroupManagement()

Parameters:

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

Returns:

this

authMode

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

Sets the value of CfnDomainMixinProps.getAuthMode()

Parameters:

authMode - The mode of authentication that members use to access the Domain. Valid Values : SSO | IAM

Returns:

this

defaultSpaceSettings

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

Sets the value of CfnDomainMixinProps.getDefaultSpaceSettings()

Parameters:

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.

Returns:

this

defaultSpaceSettings

@Stability(Stable)
public CfnDomainMixinProps.Builder defaultSpaceSettings(CfnDomainPropsMixin.DefaultSpaceSettingsProperty defaultSpaceSettings)

Sets the value of CfnDomainMixinProps.getDefaultSpaceSettings()

Parameters:

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.

Returns:

this

defaultUserSettings

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

Sets the value of CfnDomainMixinProps.getDefaultUserSettings()

Parameters:

defaultUserSettings - The default user settings.

Returns:

this

defaultUserSettings

@Stability(Stable)
public CfnDomainMixinProps.Builder defaultUserSettings(CfnDomainPropsMixin.UserSettingsProperty defaultUserSettings)

Sets the value of CfnDomainMixinProps.getDefaultUserSettings()

Parameters:

defaultUserSettings - The default user settings.

Returns:

this

domainName

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

Sets the value of CfnDomainMixinProps.getDomainName()

Parameters:

domainName - The domain name.

Returns:

this

domainSettings

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

Sets the value of CfnDomainMixinProps.getDomainSettings()

Parameters:

domainSettings - A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.

Returns:

this

domainSettings

@Stability(Stable)
public CfnDomainMixinProps.Builder domainSettings(CfnDomainPropsMixin.DomainSettingsProperty domainSettings)

Sets the value of CfnDomainMixinProps.getDomainSettings()

Parameters:

domainSettings - A collection of settings that apply to the SageMaker Domain . These settings are specified through the CreateDomain API call.

Returns:

this

kmsKeyId

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

Sets the value of CfnDomainMixinProps.getKmsKeyId()

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. For more control, specify a customer managed CMK.

Length Constraints : Maximum length of 2048.

Pattern : .*

Returns:

this

subnetIds

@Stability(Stable)
public CfnDomainMixinProps.Builder subnetIds(List<? extends Object> subnetIds)

Sets the value of CfnDomainMixinProps.getSubnetIds()

Parameters:

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]+

Returns:

this

tagPropagation

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

Sets the value of CfnDomainMixinProps.getTagPropagation()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnDomainMixinProps.getTags()

Parameters:

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.

Returns:

this

vpcId

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

Sets the value of CfnDomainMixinProps.getVpcId()

Parameters:

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]+

Returns:

this

vpcId

@Stability(Stable)
public CfnDomainMixinProps.Builder vpcId(IVPCRef vpcId)

Sets the value of CfnDomainMixinProps.getVpcId()

Parameters:

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]+

Returns:

this

build

@Stability(Stable)
public CfnDomainMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDomainMixinProps

Throws:

NullPointerException - if any required attribute was not provided