Interface CfnDomainProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.150Z") @Stability(Stable) public interface CfnDomainProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnDomain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .authMode("authMode")
         .defaultUserSettings(UserSettingsProperty.builder()
                 .executionRole("executionRole")
                 // the properties below are optional
                 .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .rSessionAppSettings(RSessionAppSettingsProperty.builder()
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder()
                         .accessStatus("accessStatus")
                         .userGroup("userGroup")
                         .build())
                 .securityGroups(List.of("securityGroups"))
                 .sharingSettings(SharingSettingsProperty.builder()
                         .notebookOutputOption("notebookOutputOption")
                         .s3KmsKeyId("s3KmsKeyId")
                         .s3OutputPath("s3OutputPath")
                         .build())
                 .build())
         .domainName("domainName")
         .subnetIds(List.of("subnetIds"))
         .vpcId("vpcId")
         // the properties below are optional
         .appNetworkAccessType("appNetworkAccessType")
         .appSecurityGroupManagement("appSecurityGroupManagement")
         .defaultSpaceSettings(DefaultSpaceSettingsProperty.builder()
                 .executionRole("executionRole")
                 // the properties below are optional
                 .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .build())
                 .securityGroups(List.of("securityGroups"))
                 .build())
         .domainSettings(DomainSettingsProperty.builder()
                 .rStudioServerProDomainSettings(RStudioServerProDomainSettingsProperty.builder()
                         .domainExecutionRoleArn("domainExecutionRoleArn")
                         // the properties below are optional
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .rStudioConnectUrl("rStudioConnectUrl")
                         .rStudioPackageManagerUrl("rStudioPackageManagerUrl")
                         .build())
                 .securityGroupIds(List.of("securityGroupIds"))
                 .build())
         .kmsKeyId("kmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 
  • Method Details

    • getAuthMode

      @Stability(Stable) @NotNull String getAuthMode()
      The mode of authentication that members use to access the Domain.

      Valid Values : SSO | IAM

    • getDefaultUserSettings

      @Stability(Stable) @NotNull Object getDefaultUserSettings()
      The default user settings.
    • getDomainName

      @Stability(Stable) @NotNull String getDomainName()
      The domain name.
    • getSubnetIds

      @Stability(Stable) @NotNull List<String> getSubnetIds()
      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]+

    • getVpcId

      @Stability(Stable) @NotNull String getVpcId()
      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]+

    • getAppNetworkAccessType

      @Stability(Stable) @Nullable default String getAppNetworkAccessType()
      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

    • getAppSecurityGroupManagement

      @Stability(Stable) @Nullable default String getAppSecurityGroupManagement()
      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

    • getDefaultSpaceSettings

      @Stability(Stable) @Nullable default Object getDefaultSpaceSettings()
      AWS::SageMaker::Domain.DefaultSpaceSettings.
    • getDomainSettings

      @Stability(Stable) @Nullable default Object getDomainSettings()
      A collection of settings that apply to the SageMaker Domain .

      These settings are specified through the CreateDomain API call.

    • getKmsKeyId

      @Stability(Stable) @Nullable default String getKmsKeyId()
      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 : .*

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      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.

    • builder

      @Stability(Stable) static CfnDomainProps.Builder builder()
      Returns:
      a CfnDomainProps.Builder of CfnDomainProps