Class CfnLaunchProfile
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.nimblestudio.CfnLaunchProfile
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-17T19:20:32.001Z")
@Stability(Stable)
public class CfnLaunchProfile
extends CfnResource
implements IInspectable, ITaggable
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.
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.nimblestudio.*; CfnLaunchProfile cfnLaunchProfile = CfnLaunchProfile.Builder.create(this, "MyCfnLaunchProfile") .ec2SubnetIds(List.of("ec2SubnetIds")) .launchProfileProtocolVersions(List.of("launchProfileProtocolVersions")) .name("name") .streamConfiguration(StreamConfigurationProperty.builder() .clipboardMode("clipboardMode") .ec2InstanceTypes(List.of("ec2InstanceTypes")) .streamingImageIds(List.of("streamingImageIds")) // the properties below are optional .automaticTerminationMode("automaticTerminationMode") .maxSessionLengthInMinutes(123) .maxStoppedSessionLengthInMinutes(123) .sessionBackup(StreamConfigurationSessionBackupProperty.builder() .maxBackupsToRetain(123) .mode("mode") .build()) .sessionPersistenceMode("sessionPersistenceMode") .sessionStorage(StreamConfigurationSessionStorageProperty.builder() .mode(List.of("mode")) // the properties below are optional .root(StreamingSessionStorageRootProperty.builder() .linux("linux") .windows("windows") .build()) .build()) .volumeConfiguration(VolumeConfigurationProperty.builder() .iops(123) .size(123) .throughput(123) .build()) .build()) .studioComponentIds(List.of("studioComponentIds")) .studioId("studioId") // the properties below are optional .description("description") .tags(Map.of( "tagsKey", "tags")) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnLaunchProfile
.static interface
A configuration for a streaming session.static interface
Configures how streaming sessions are backed up when launched from this launch profile.static interface
The configuration for a streaming session’s upload storage.static interface
The upload storage root location (folder) on streaming workstations where files are uploaded.static interface
Custom volume configuration for the root volumes that are attached to streaming sessions.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnLaunchProfile
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnLaunchProfile
(software.amazon.jsii.JsiiObjectRef objRef) CfnLaunchProfile
(software.constructs.Construct scope, String id, CfnLaunchProfileProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe unique identifier for the launch profile resource.A human-readable description of the launch profile.Unique identifiers for a collection of EC2 subnets.The version number of the protocol that is used by the launch profile.getName()
A friendly name for the launch profile.A configuration for a streaming session.Unique identifiers for a collection of studio components that can be used with this launch profile.The unique identifier for a studio resource.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) A human-readable description of the launch profile.void
setEc2SubnetIds
(List<String> value) Unique identifiers for a collection of EC2 subnets.void
The version number of the protocol that is used by the launch profile.void
A friendly name for the launch profile.void
A configuration for a streaming session.void
A configuration for a streaming session.void
setStudioComponentIds
(List<String> value) Unique identifiers for a collection of studio components that can be used with this launch profile.void
setStudioId
(String value) The unique identifier for a studio resource.void
setTagsRaw
(Map<String, String> value) An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnLaunchProfile
protected CfnLaunchProfile(software.amazon.jsii.JsiiObjectRef objRef) -
CfnLaunchProfile
protected CfnLaunchProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnLaunchProfile
@Stability(Stable) public CfnLaunchProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLaunchProfileProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrLaunchProfileId
The unique identifier for the launch profile resource. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getEc2SubnetIds
Unique identifiers for a collection of EC2 subnets. -
setEc2SubnetIds
Unique identifiers for a collection of EC2 subnets. -
getLaunchProfileProtocolVersions
The version number of the protocol that is used by the launch profile. -
setLaunchProfileProtocolVersions
The version number of the protocol that is used by the launch profile. -
getName
A friendly name for the launch profile. -
setName
A friendly name for the launch profile. -
getStreamConfiguration
A configuration for a streaming session. -
setStreamConfiguration
A configuration for a streaming session. -
setStreamConfiguration
@Stability(Stable) public void setStreamConfiguration(@NotNull CfnLaunchProfile.StreamConfigurationProperty value) A configuration for a streaming session. -
getStudioComponentIds
Unique identifiers for a collection of studio components that can be used with this launch profile. -
setStudioComponentIds
Unique identifiers for a collection of studio components that can be used with this launch profile. -
getStudioId
The unique identifier for a studio resource. -
setStudioId
The unique identifier for a studio resource. -
getDescription
A human-readable description of the launch profile. -
setDescription
A human-readable description of the launch profile. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-