Package software.amazon.awscdk.services.sagemaker

Interface CfnDomain.DefaultSpaceSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.DefaultSpaceSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.DefaultSpaceSettingsProperty
extends software.amazon.jsii.JsiiSerializable

A collection of settings that apply to spaces created in the Domain.

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.*;
 DefaultSpaceSettingsProperty defaultSpaceSettingsProperty = 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.DefaultSpaceSettingsProperty.Builder	A builder for CfnDomain.DefaultSpaceSettingsProperty
static final class	CfnDomain.DefaultSpaceSettingsProperty.Jsii$Proxy	An implementation for CfnDomain.DefaultSpaceSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.DefaultSpaceSettingsProperty.Builder	builder()
String	getExecutionRole()	The ARN of the execution role for the space.
default Object	getJupyterServerAppSettings()	The JupyterServer app settings.
default Object	getKernelGatewayAppSettings()	The KernelGateway app settings.
default List<String>	getSecurityGroups()	The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRole

@Stability(Stable)
@NotNull
String getExecutionRole()

The ARN of the execution role for the space.

getJupyterServerAppSettings

@Stability(Stable)
@Nullable
default Object getJupyterServerAppSettings()

The JupyterServer app settings.

getKernelGatewayAppSettings

@Stability(Stable)
@Nullable
default Object getKernelGatewayAppSettings()

The KernelGateway app settings.

getSecurityGroups

@Stability(Stable)
@Nullable
default List<String> getSecurityGroups()

The security group IDs for the Amazon Virtual Private Cloud that the space uses for communication.

builder

@Stability(Stable)
static CfnDomain.DefaultSpaceSettingsProperty.Builder builder()

Returns:

a CfnDomain.DefaultSpaceSettingsProperty.Builder of CfnDomain.DefaultSpaceSettingsProperty