Package software.amazon.awscdk.services.sagemaker

Class CfnDomainProps.Builder

java.lang.Object
software.amazon.awscdk.services.sagemaker.CfnDomainProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDomainProps>
Enclosing interface:
CfnDomainProps
@Stability(Stable) public static final class CfnDomainProps.Builder extends Object implements software.amazon.jsii.Builder<CfnDomainProps>
A builder for CfnDomainProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • authMode

      @Stability(Stable) public CfnDomainProps.Builder authMode(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

      @Stability(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) public CfnDomainProps.Builder domainName(String domainName)
      Sets the value of CfnDomainProps.getDomainName()
      Parameters:
      domainName - The domain name. This parameter is required.
      Returns:
      this

    • subnetIds

      @Stability(Stable) public CfnDomainProps.Builder subnetIds(List<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

      @Stability(Stable) public CfnDomainProps.Builder vpcId(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

      @Stability(Stable) public CfnDomainProps.Builder appNetworkAccessType(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

      @Stability(Stable) public CfnDomainProps.Builder appSecurityGroupManagement(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. If setting up the domain for use with RStudio, this value must be set to Service .

      Allowed Values : Service | Customer

      Returns:
      this

    • defaultSpaceSettings

      @Stability(Stable) public CfnDomainProps.Builder defaultSpaceSettings(IResolvable defaultSpaceSettings)
      Sets the value of CfnDomainProps.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 CfnDomainProps.Builder defaultSpaceSettings(CfnDomain.DefaultSpaceSettingsProperty defaultSpaceSettings)
      Sets the value of CfnDomainProps.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

    • domainSettings

      @Stability(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) public CfnDomainProps.Builder kmsKeyId(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

    • tagPropagation

      @Stability(Stable) public CfnDomainProps.Builder tagPropagation(String tagPropagation)
      Sets the value of CfnDomainProps.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 CfnDomainProps.Builder tags(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

      @Stability(Stable) public CfnDomainProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDomainProps>
      Returns:
      a new instance of CfnDomainProps
      Throws:
      NullPointerException - if any required attribute was not provided