software.amazon.awscdk.services.sagemaker

Interface CfnDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.803Z")
 @Stability(value=Stable)
public interface CfnDomainProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::SageMaker::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.*;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .authMode("authMode")
         .defaultUserSettings(UserSettingsProperty.builder()
                 .executionRole("executionRole")
                 .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .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")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .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")
         .kmsKeyId("kmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDomainProps.Builder	builder()
default String	getAppNetworkAccessType() `AWS::SageMaker::Domain.AppNetworkAccessType`.
String	getAuthMode() `AWS::SageMaker::Domain.AuthMode`.
Object	getDefaultUserSettings() `AWS::SageMaker::Domain.DefaultUserSettings`.
String	getDomainName() `AWS::SageMaker::Domain.DomainName`.
default String	getKmsKeyId() `AWS::SageMaker::Domain.KmsKeyId`.
List<String>	getSubnetIds() `AWS::SageMaker::Domain.SubnetIds`.
default List<CfnTag>	getTags() `AWS::SageMaker::Domain.Tags`.
String	getVpcId() `AWS::SageMaker::Domain.VpcId`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAppNetworkAccessType

@Stability(value=Stable)
 @Nullable
default String getAppNetworkAccessType()

`AWS::SageMaker::Domain.AppNetworkAccessType`.

getAuthMode

@Stability(value=Stable)
 @NotNull
String getAuthMode()

`AWS::SageMaker::Domain.AuthMode`.

getDefaultUserSettings

@Stability(value=Stable)
 @NotNull
Object getDefaultUserSettings()

`AWS::SageMaker::Domain.DefaultUserSettings`.

getDomainName

@Stability(value=Stable)
 @NotNull
String getDomainName()

`AWS::SageMaker::Domain.DomainName`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

`AWS::SageMaker::Domain.KmsKeyId`.

getSubnetIds

@Stability(value=Stable)
 @NotNull
List<String> getSubnetIds()

`AWS::SageMaker::Domain.SubnetIds`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::SageMaker::Domain.Tags`.

getVpcId

@Stability(value=Stable)
 @NotNull
String getVpcId()

`AWS::SageMaker::Domain.VpcId`.

builder

@Stability(value=Stable)
static CfnDomainProps.Builder builder()

Returns:

a CfnDomainProps.Builder of CfnDomainProps