software.amazon.awscdk.services.sagemaker

Class CfnDomainProps.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnDomainProps.Builder

Enclosing interface:

CfnDomainProps

public static final class CfnDomainProps.Builder
extends java.lang.Object

A builder for CfnDomainProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

authMode

public CfnDomainProps.Builder authMode(java.lang.String authMode)

Sets the value of CfnDomainProps.getAuthMode()

Parameters:

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

Returns:

this

defaultUserSettings

public CfnDomainProps.Builder defaultUserSettings(IResolvable defaultUserSettings)

Sets the value of CfnDomainProps.getDefaultUserSettings()

Parameters:

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

Returns:

this

defaultUserSettings

public CfnDomainProps.Builder defaultUserSettings(CfnDomain.UserSettingsProperty defaultUserSettings)

Sets the value of CfnDomainProps.getDefaultUserSettings()

Parameters:

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

Returns:

this

domainName

public CfnDomainProps.Builder domainName(java.lang.String domainName)

Sets the value of CfnDomainProps.getDomainName()

Parameters:

domainName - The domain name. This parameter is required.

Returns:

this

subnetIds

public CfnDomainProps.Builder subnetIds(java.util.List<java.lang.String> subnetIds)

Sets the value of CfnDomainProps.getSubnetIds()

Parameters:

subnetIds - The VPC subnets that Studio uses for communication. This parameter is required. 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

vpcId

public CfnDomainProps.Builder vpcId(java.lang.String vpcId)

Sets the value of CfnDomainProps.getVpcId()

Parameters:

vpcId - The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication. This parameter is required. Length Constraints : Maximum length of 32.

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

Returns:

this

appNetworkAccessType

public CfnDomainProps.Builder appNetworkAccessType(java.lang.String appNetworkAccessType)

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

Valid Values : PublicInternetOnly | VpcOnly

Returns:

this

appSecurityGroupManagement

public CfnDomainProps.Builder appSecurityGroupManagement(java.lang.String appSecurityGroupManagement)

Sets the value of CfnDomainProps.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.

Returns:

this

defaultSpaceSettings

public CfnDomainProps.Builder defaultSpaceSettings(IResolvable defaultSpaceSettings)

Sets the value of CfnDomainProps.getDefaultSpaceSettings()

Parameters:

defaultSpaceSettings - `AWS::SageMaker::Domain.DefaultSpaceSettings`.

Returns:

this

defaultSpaceSettings

public CfnDomainProps.Builder defaultSpaceSettings(CfnDomain.DefaultSpaceSettingsProperty defaultSpaceSettings)

Sets the value of CfnDomainProps.getDefaultSpaceSettings()

Parameters:

defaultSpaceSettings - `AWS::SageMaker::Domain.DefaultSpaceSettings`.

Returns:

this

domainSettings

public CfnDomainProps.Builder domainSettings(IResolvable domainSettings)

Sets the value of CfnDomainProps.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

public CfnDomainProps.Builder domainSettings(CfnDomain.DomainSettingsProperty domainSettings)

Sets the value of CfnDomainProps.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

public CfnDomainProps.Builder kmsKeyId(java.lang.String kmsKeyId)

Sets the value of CfnDomainProps.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

tags

public CfnDomainProps.Builder tags(java.util.List<? extends CfnTag> tags)

Sets the value of CfnDomainProps.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

build

public CfnDomainProps build()

Builds the configured instance.

Returns:

a new instance of CfnDomainProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided