@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:49.306Z") public class CfnLaunchProfile extends CfnResource implements IInspectable
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) .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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnLaunchProfile.Builder
A fluent builder for
CfnLaunchProfile . |
static interface |
CfnLaunchProfile.StreamConfigurationProperty
A configuration for a streaming session.
|
static interface |
CfnLaunchProfile.StreamConfigurationSessionStorageProperty
The configuration for a streaming session’s upload storage.
|
static interface |
CfnLaunchProfile.StreamingSessionStorageRootProperty
The upload storage root location (folder) on streaming workstations where files are uploaded.
|
static interface |
CfnLaunchProfile.VolumeConfigurationProperty
Custom volume configuration for the root volumes that are attached to streaming sessions.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnLaunchProfile(Construct scope,
java.lang.String id,
CfnLaunchProfileProps props)
Create a new `AWS::NimbleStudio::LaunchProfile`.
|
protected |
CfnLaunchProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnLaunchProfile(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrLaunchProfileId()
The unique identifier for the launch profile resource.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A human-readable description of the launch profile.
|
java.util.List<java.lang.String> |
getEc2SubnetIds()
Unique identifiers for a collection of EC2 subnets.
|
java.util.List<java.lang.String> |
getLaunchProfileProtocolVersions()
The version number of the protocol that is used by the launch profile.
|
java.lang.String |
getName()
A friendly name for the launch profile.
|
java.lang.Object |
getStreamConfiguration()
A configuration for a streaming session.
|
java.util.List<java.lang.String> |
getStudioComponentIds()
Unique identifiers for a collection of studio components that can be used with this launch profile.
|
java.lang.String |
getStudioId()
The unique identifier for a studio resource.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.String value)
A human-readable description of the launch profile.
|
void |
setEc2SubnetIds(java.util.List<java.lang.String> value)
Unique identifiers for a collection of EC2 subnets.
|
void |
setLaunchProfileProtocolVersions(java.util.List<java.lang.String> value)
The version number of the protocol that is used by the launch profile.
|
void |
setName(java.lang.String value)
A friendly name for the launch profile.
|
void |
setStreamConfiguration(CfnLaunchProfile.StreamConfigurationProperty value)
A configuration for a streaming session.
|
void |
setStreamConfiguration(IResolvable value)
A configuration for a streaming session.
|
void |
setStudioComponentIds(java.util.List<java.lang.String> value)
Unique identifiers for a collection of studio components that can be used with this launch profile.
|
void |
setStudioId(java.lang.String value)
The unique identifier for a studio resource.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnLaunchProfile(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnLaunchProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnLaunchProfile(Construct scope, java.lang.String id, CfnLaunchProfileProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrLaunchProfileId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.util.List<java.lang.String> getEc2SubnetIds()
public void setEc2SubnetIds(java.util.List<java.lang.String> value)
public java.util.List<java.lang.String> getLaunchProfileProtocolVersions()
The only valid version is "2021-03-31".
public void setLaunchProfileProtocolVersions(java.util.List<java.lang.String> value)
The only valid version is "2021-03-31".
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getStreamConfiguration()
public void setStreamConfiguration(CfnLaunchProfile.StreamConfigurationProperty value)
public void setStreamConfiguration(IResolvable value)
public java.util.List<java.lang.String> getStudioComponentIds()
public void setStudioComponentIds(java.util.List<java.lang.String> value)
public java.lang.String getStudioId()
In Nimble Studio , all other resources are contained in a studio resource.
public void setStudioId(java.lang.String value)
In Nimble Studio , all other resources are contained in a studio resource.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)