software.amazon.awscdk.services.sagemaker

Class CfnDomain

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnDomain

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.801Z")
 @Stability(value=Stable)
public class CfnDomain
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .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	Class and Description
static class	CfnDomain.Builder A fluent builder for CfnDomain.
static interface	CfnDomain.CustomImageProperty Example:
static interface	CfnDomain.JupyterServerAppSettingsProperty Example:
static interface	CfnDomain.KernelGatewayAppSettingsProperty Example:
static interface	CfnDomain.ResourceSpecProperty Example:
static interface	CfnDomain.SharingSettingsProperty Example:
static interface	CfnDomain.UserSettingsProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDomain(software.constructs.Construct scope, String id, CfnDomainProps props) Create a new `AWS::SageMaker::Domain`.
protected	CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAppNetworkAccessType() `AWS::SageMaker::Domain.AppNetworkAccessType`.
String	getAttrDomainArn()
String	getAttrDomainId()
String	getAttrHomeEfsFileSystemId()
String	getAttrSingleSignOnManagedApplicationInstanceId()
String	getAttrUrl()
String	getAuthMode() `AWS::SageMaker::Domain.AuthMode`.
protected Map<String,Object>	getCfnProperties()
Object	getDefaultUserSettings() `AWS::SageMaker::Domain.DefaultUserSettings`.
String	getDomainName() `AWS::SageMaker::Domain.DomainName`.
String	getKmsKeyId() `AWS::SageMaker::Domain.KmsKeyId`.
List<String>	getSubnetIds() `AWS::SageMaker::Domain.SubnetIds`.
TagManager	getTags() `AWS::SageMaker::Domain.Tags`.
String	getVpcId() `AWS::SageMaker::Domain.VpcId`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAppNetworkAccessType(String value) `AWS::SageMaker::Domain.AppNetworkAccessType`.
void	setAuthMode(String value) `AWS::SageMaker::Domain.AuthMode`.
void	setDefaultUserSettings(CfnDomain.UserSettingsProperty value) `AWS::SageMaker::Domain.DefaultUserSettings`.
void	setDefaultUserSettings(IResolvable value) `AWS::SageMaker::Domain.DefaultUserSettings`.
void	setDomainName(String value) `AWS::SageMaker::Domain.DomainName`.
void	setKmsKeyId(String value) `AWS::SageMaker::Domain.KmsKeyId`.
void	setSubnetIds(List<String> value) `AWS::SageMaker::Domain.SubnetIds`.
void	setVpcId(String value) `AWS::SageMaker::Domain.VpcId`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDomain

protected CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)

CfnDomain

protected CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDomain

@Stability(value=Stable)
public CfnDomain(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnDomainProps props)

Create a new `AWS::SageMaker::Domain`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAppNetworkAccessType

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

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

setAppNetworkAccessType

@Stability(value=Stable)
public void setAppNetworkAccessType(@Nullable
                                                             String value)

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

getAttrDomainArn

@Stability(value=Stable)
 @NotNull
public String getAttrDomainArn()

getAttrDomainId

@Stability(value=Stable)
 @NotNull
public String getAttrDomainId()

getAttrHomeEfsFileSystemId

@Stability(value=Stable)
 @NotNull
public String getAttrHomeEfsFileSystemId()

getAttrSingleSignOnManagedApplicationInstanceId

@Stability(value=Stable)
 @NotNull
public String getAttrSingleSignOnManagedApplicationInstanceId()

getAttrUrl

@Stability(value=Stable)
 @NotNull
public String getAttrUrl()

getAuthMode

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

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

setAuthMode

@Stability(value=Stable)
public void setAuthMode(@NotNull
                                                 String value)

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDefaultUserSettings

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

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

setDefaultUserSettings

@Stability(value=Stable)
public void setDefaultUserSettings(@NotNull
                                                            CfnDomain.UserSettingsProperty value)

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

setDefaultUserSettings

@Stability(value=Stable)
public void setDefaultUserSettings(@NotNull
                                                            IResolvable value)

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

getDomainName

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

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

setDomainName

@Stability(value=Stable)
public void setDomainName(@NotNull
                                                   String value)

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

getKmsKeyId

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

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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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

getSubnetIds

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

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

setSubnetIds

@Stability(value=Stable)
public void setSubnetIds(@NotNull
                                                  List<String> value)

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

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getVpcId

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

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

setVpcId

@Stability(value=Stable)
public void setVpcId(@NotNull
                                              String value)

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