@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:39.630Z") public class CfnApp extends CfnResource implements IInspectable
Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
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.*; CfnApp cfnApp = CfnApp.Builder.create(this, "MyCfnApp") .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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnApp.Builder
A fluent builder for
CfnApp . |
static interface |
CfnApp.ResourceSpecProperty
Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnApp(Construct scope,
java.lang.String id,
CfnAppProps props)
Create a new `AWS::SageMaker::App`.
|
protected |
CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnApp(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAppName()
The name of the app.
|
java.lang.String |
getAppType()
The type of app.
|
java.lang.String |
getAttrAppArn()
The Amazon Resource Name (ARN) of the app, such as `arn:aws:sagemaker:us-west-2:account-id:app/my-app-name` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDomainId()
The domain ID.
|
java.lang.Object |
getResourceSpec()
Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
java.lang.String |
getUserProfileName()
The user profile name.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAppName(java.lang.String value)
The name of the app.
|
void |
setAppType(java.lang.String value)
The type of app.
|
void |
setDomainId(java.lang.String value)
The domain ID.
|
void |
setResourceSpec(CfnApp.ResourceSpecProperty value)
Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
|
void |
setResourceSpec(IResolvable value)
Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
|
void |
setUserProfileName(java.lang.String value)
The user profile name.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnApp(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnApp(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnApp(Construct scope, java.lang.String id, CfnAppProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrAppArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getAppName()
public void setAppName(java.lang.String value)
public java.lang.String getAppType()
Allowed Values : JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas
public void setAppType(java.lang.String value)
Allowed Values : JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas
public java.lang.String getDomainId()
public void setDomainId(java.lang.String value)
public java.lang.String getUserProfileName()
public void setUserProfileName(java.lang.String value)
public java.lang.Object getResourceSpec()
public void setResourceSpec(CfnApp.ResourceSpecProperty value)
public void setResourceSpec(IResolvable value)