Class CfnSpace
Creates a space used for real time collaboration in a domain.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSpace : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnSpace
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-space.html
CloudformationResource: AWS::SageMaker::Space
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 cfnSpace = new CfnSpace(this, "MyCfnSpace", new CfnSpaceProps {
DomainId = "domainId",
SpaceName = "spaceName",
// the properties below are optional
OwnershipSettings = new OwnershipSettingsProperty {
OwnerUserProfileName = "ownerUserProfileName"
},
SpaceDisplayName = "spaceDisplayName",
SpaceSettings = new SpaceSettingsProperty {
AppType = "appType",
CodeEditorAppSettings = new SpaceCodeEditorAppSettingsProperty {
DefaultResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
}
},
CustomFileSystems = new [] { new CustomFileSystemProperty {
EfsFileSystem = new EFSFileSystemProperty {
FileSystemId = "fileSystemId"
}
} },
JupyterLabAppSettings = new SpaceJupyterLabAppSettingsProperty {
CodeRepositories = new [] { new CodeRepositoryProperty {
RepositoryUrl = "repositoryUrl"
} },
DefaultResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
}
},
JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
DefaultResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
}
},
KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
CustomImages = new [] { new CustomImageProperty {
AppImageConfigName = "appImageConfigName",
ImageName = "imageName",
// the properties below are optional
ImageVersionNumber = 123
} },
DefaultResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
}
},
SpaceStorageSettings = new SpaceStorageSettingsProperty {
EbsStorageSettings = new EbsStorageSettingsProperty {
EbsVolumeSizeInGb = 123
}
}
},
SpaceSharingSettings = new SpaceSharingSettingsProperty {
SharingType = "sharingType"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnSpace(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSpace(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSpace(Construct, String, ICfnSpaceProps) |
Properties
AttrSpaceArn | The space's Amazon Resource Name (ARN). |
AttrUrl | Returns the URL of the space. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DomainId | The ID of the associated domain. |
OwnershipSettings | The collection of ownership settings for a space. |
SpaceDisplayName | The name of the space that appears in the Studio UI. |
SpaceName | The name of the space. |
SpaceSettings | A collection of space settings. |
SpaceSharingSettings | A collection of space sharing settings. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSpace(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSpace(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSpace(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSpace(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSpace(Construct, String, ICfnSpaceProps)
public CfnSpace(Construct scope, string id, ICfnSpaceProps 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 ICfnSpaceProps
Resource properties.
Properties
AttrSpaceArn
The space's Amazon Resource Name (ARN).
public virtual string AttrSpaceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SpaceArn
AttrUrl
Returns the URL of the space.
public virtual string AttrUrl { get; }
Property Value
System.String
Remarks
If the space is created with AWS IAM Identity Center (Successor to AWS Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through AWS IAM Identity Center.
The following application types are supported:
CloudformationAttribute: Url
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 ID of the associated domain.
public virtual string DomainId { get; set; }
Property Value
System.String
OwnershipSettings
The collection of ownership settings for a space.
public virtual object OwnershipSettings { get; set; }
Property Value
System.Object
SpaceDisplayName
The name of the space that appears in the Studio UI.
public virtual string SpaceDisplayName { get; set; }
Property Value
System.String
SpaceName
The name of the space.
public virtual string SpaceName { get; set; }
Property Value
System.String
SpaceSettings
A collection of space settings.
public virtual object SpaceSettings { get; set; }
Property Value
System.Object
SpaceSharingSettings
A collection of space sharing settings.
public virtual object SpaceSharingSettings { 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[]
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>