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 Details

    • create

      @Stability(Stable) public static CfnDomain.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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

    • 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

    • 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

    • domainName

      @Stability(Stable) public CfnDomain.Builder domainName(String domainName)
      The domain name.

      Parameters:
      domainName - The domain name. This parameter is required.
      Returns:
      this

    • 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

    • 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

    • 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

    • 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

    • defaultSpaceSettings

      @Stability(Stable) public CfnDomain.Builder defaultSpaceSettings(IResolvable defaultSpaceSettings)
      AWS::SageMaker::Domain.DefaultSpaceSettings.

      Parameters:
      defaultSpaceSettings - AWS::SageMaker::Domain.DefaultSpaceSettings. This parameter is required.
      Returns:
      this

    • defaultSpaceSettings

      @Stability(Stable) public CfnDomain.Builder defaultSpaceSettings(CfnDomain.DefaultSpaceSettingsProperty defaultSpaceSettings)
      AWS::SageMaker::Domain.DefaultSpaceSettings.

      Parameters:
      defaultSpaceSettings - AWS::SageMaker::Domain.DefaultSpaceSettings. This parameter is required.
      Returns:
      this

    • 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

    • 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

    • 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

    • 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

    • build

      @Stability(Stable) public CfnDomain build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDomain>
      Returns:
      a newly built instance of CfnDomain.