Class CfnApp
Creates a running app for the specified UserProfile.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApp : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnApp
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-app.html
CloudformationResource: AWS::SageMaker::App
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(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 |
CfnApp(Construct, String, ICfnAppProps) |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnApp(Construct, String, ICfnAppProps)
public CfnApp(Construct scope, string id, ICfnAppProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAppProps
Resource properties.
Properties
AppName
The name of the app.
public virtual string AppName { get; set; }
Property Value
System.String
AppType
The type of app.
public virtual string AppType { get; set; }
Property Value
System.String
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
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
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
UserProfileName
The user profile name.
public virtual string UserProfileName { get; set; }
Property Value
System.String
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>