Class CfnLaunchProfile
A CloudFormation AWS::NimbleStudio::LaunchProfile
.
Inherited Members
Namespace: Amazon.CDK.AWS.NimbleStudio
Assembly: Amazon.CDK.AWS.NimbleStudio.dll
Syntax (csharp)
public class CfnLaunchProfile : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnLaunchProfile
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::NimbleStudio::LaunchProfile
resource represents access permissions for a set of studio components, including types of workstations, render farms, and shared file systems. Launch profiles are shared with studio users to give them access to the set of studio components.
CloudformationResource: AWS::NimbleStudio::LaunchProfile
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.NimbleStudio;
var cfnLaunchProfile = new CfnLaunchProfile(this, "MyCfnLaunchProfile", new CfnLaunchProfileProps {
Ec2SubnetIds = new [] { "ec2SubnetIds" },
LaunchProfileProtocolVersions = new [] { "launchProfileProtocolVersions" },
Name = "name",
StreamConfiguration = new StreamConfigurationProperty {
ClipboardMode = "clipboardMode",
Ec2InstanceTypes = new [] { "ec2InstanceTypes" },
StreamingImageIds = new [] { "streamingImageIds" },
// the properties below are optional
AutomaticTerminationMode = "automaticTerminationMode",
MaxSessionLengthInMinutes = 123,
MaxStoppedSessionLengthInMinutes = 123,
SessionBackup = new StreamConfigurationSessionBackupProperty {
MaxBackupsToRetain = 123,
Mode = "mode"
},
SessionPersistenceMode = "sessionPersistenceMode",
SessionStorage = new StreamConfigurationSessionStorageProperty {
Mode = new [] { "mode" },
// the properties below are optional
Root = new StreamingSessionStorageRootProperty {
Linux = "linux",
Windows = "windows"
}
},
VolumeConfiguration = new VolumeConfigurationProperty {
Iops = 123,
Size = 123,
Throughput = 123
}
},
StudioComponentIds = new [] { "studioComponentIds" },
StudioId = "studioId",
// the properties below are optional
Description = "description",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
Synopsis
Constructors
CfnLaunchProfile(Construct, String, ICfnLaunchProfileProps) | Create a new |
CfnLaunchProfile(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnLaunchProfile(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrLaunchProfileId | The unique identifier for the launch profile resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A human-readable description of the launch profile. |
Ec2SubnetIds | Unique identifiers for a collection of EC2 subnets. |
LaunchProfileProtocolVersions | The version number of the protocol that is used by the launch profile. |
Name | A friendly name for the launch profile. |
StreamConfiguration | A configuration for a streaming session. |
StudioComponentIds | Unique identifiers for a collection of studio components that can be used with this launch profile. |
StudioId | The unique identifier for a studio resource. |
Tags | 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
CfnLaunchProfile(Construct, String, ICfnLaunchProfileProps)
Create a new AWS::NimbleStudio::LaunchProfile
.
public CfnLaunchProfile(Construct scope, string id, ICfnLaunchProfileProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnLaunchProfileProps
- resource properties.
CfnLaunchProfile(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnLaunchProfile(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnLaunchProfile(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnLaunchProfile(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrLaunchProfileId
The unique identifier for the launch profile resource.
public virtual string AttrLaunchProfileId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LaunchProfileId
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
Description
A human-readable description of the launch profile.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Ec2SubnetIds
Unique identifiers for a collection of EC2 subnets.
public virtual string[] Ec2SubnetIds { get; set; }
Property Value
System.String[]
Remarks
LaunchProfileProtocolVersions
The version number of the protocol that is used by the launch profile.
public virtual string[] LaunchProfileProtocolVersions { get; set; }
Property Value
System.String[]
Remarks
The only valid version is "2021-03-31".
Name
A friendly name for the launch profile.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
StreamConfiguration
A configuration for a streaming session.
public virtual object StreamConfiguration { get; set; }
Property Value
System.Object
Remarks
StudioComponentIds
Unique identifiers for a collection of studio components that can be used with this launch profile.
public virtual string[] StudioComponentIds { get; set; }
Property Value
System.String[]
Remarks
StudioId
The unique identifier for a studio resource.
public virtual string StudioId { get; set; }
Property Value
System.String
Remarks
In Nimble Studio , all other resources are contained in a studio resource.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
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>