Class CfnApp
A CloudFormation AWS::SageMaker::App
.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnApp : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApp
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::SageMaker::App
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var cfnApp = new CfnApp(this, "MyCfnApp", new CfnAppProps {
AppName = "appName",
AppType = "appType",
DomainId = "domainId",
UserProfileName = "userProfileName",
// the properties below are optional
ResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnApp(Construct, String, ICfnAppProps) | Create a new |
CfnApp(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApp(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AppName | The name of the app. |
AppType | The type of app. |
AttrAppArn | The Amazon Resource Name (ARN) of the app, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DomainId | The domain ID. |
ResourceSpec | Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on. |
Tags | An array of key-value pairs to apply to this resource. |
UserProfileName | The user profile name. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApp(Construct, String, ICfnAppProps)
Create a new AWS::SageMaker::App
.
public CfnApp(Construct scope, string id, ICfnAppProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAppProps
- resource properties.
CfnApp(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApp(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApp(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApp(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AppName
The name of the app.
public virtual string AppName { get; set; }
Property Value
System.String
Remarks
AppType
The type of app.
public virtual string AppType { get; set; }
Property Value
System.String
Remarks
Allowed Values : JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas
AttrAppArn
The Amazon Resource Name (ARN) of the app, such as arn:aws:sagemaker:us-west-2:account-id:app/my-app-name
.
public virtual string AttrAppArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AppArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainId
The domain ID.
public virtual string DomainId { get; set; }
Property Value
System.String
Remarks
ResourceSpec
Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
public virtual object ResourceSpec { get; set; }
Property Value
System.Object
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
UserProfileName
The user profile name.
public virtual string UserProfileName { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>