software.amazon.awscdk.services.sagemaker

Interface CfnAppProps

All Known Implementing Classes:

CfnAppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.637Z")
public interface CfnAppProps

Properties for defining a `CfnApp`.

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.*;
 CfnAppProps cfnAppProps = CfnAppProps.builder()
         .appName("appName")
         .appType("appType")
         .domainId("domainId")
         .userProfileName("userProfileName")
         // the properties below are optional
         .resourceSpec(ResourceSpecProperty.builder()
                 .instanceType("instanceType")
                 .sageMakerImageArn("sageMakerImageArn")
                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnAppProps.Builder	builder()
java.lang.String	getAppName() The name of the app.
java.lang.String	getAppType() The type of app.
java.lang.String	getDomainId() The domain ID.
default java.lang.Object	getResourceSpec() Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
default java.util.List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.
java.lang.String	getUserProfileName() The user profile name.

Method Detail

getAppName

java.lang.String getAppName()

The name of the app.

getAppType

java.lang.String getAppType()

The type of app.

Allowed Values : JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas

getDomainId

java.lang.String getDomainId()

The domain ID.

getUserProfileName

java.lang.String getUserProfileName()

The user profile name.

getResourceSpec

default java.lang.Object getResourceSpec()

Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.

getTags

default java.util.List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

builder

static CfnAppProps.Builder builder()

Returns:

a CfnAppProps.Builder of CfnAppProps