software.amazon.awscdk.services.nimblestudio

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.068Z")
 @Stability(value=Stable)
public class CfnLaunchProfile
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NimbleStudio::LaunchProfile`.

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
                 .maxSessionLengthInMinutes(123)
                 .maxStoppedSessionLengthInMinutes(123)
                 .sessionStorage(StreamConfigurationSessionStorageProperty.builder()
                         .mode(List.of("mode"))
                         // the properties below are optional
                         .root(StreamingSessionStorageRootProperty.builder()
                                 .linux("linux")
                                 .windows("windows")
                                 .build())
                         .build())
                 .build())
         .studioComponentIds(List.of("studioComponentIds"))
         .studioId("studioId")
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLaunchProfile(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAttrLaunchProfileId() The unique identifier for the launch profile resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A human-readable description of the launch profile.
List<String>	getEc2SubnetIds() Unique identifiers for a collection of EC2 subnets.
List<String>	getLaunchProfileProtocolVersions() The version number of the protocol that is used by the launch profile.
String	getName() A friendly name for the launch profile.
Object	getStreamConfiguration() A configuration for a streaming session.
List<String>	getStudioComponentIds() Unique identifiers for a collection of studio components that can be used with this launch profile.
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 Map<String,Object>	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	setLaunchProfileProtocolVersions(List<String> value) The version number of the protocol that is used by the launch profile.
void	setName(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(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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLaunchProfile

protected CfnLaunchProfile(software.amazon.jsii.JsiiObjectRef objRef)

CfnLaunchProfile

protected CfnLaunchProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnLaunchProfile

@Stability(value=Stable)
public CfnLaunchProfile(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnLaunchProfileProps props)

Create a new `AWS::NimbleStudio::LaunchProfile`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrLaunchProfileId

@Stability(value=Stable)
 @NotNull
public String getAttrLaunchProfileId()

The unique identifier for the launch profile resource.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getEc2SubnetIds

@Stability(value=Stable)
 @NotNull
public List<String> getEc2SubnetIds()

Unique identifiers for a collection of EC2 subnets.

setEc2SubnetIds

@Stability(value=Stable)
public void setEc2SubnetIds(@NotNull
                                                     List<String> value)

Unique identifiers for a collection of EC2 subnets.

getLaunchProfileProtocolVersions

@Stability(value=Stable)
 @NotNull
public List<String> getLaunchProfileProtocolVersions()

The version number of the protocol that is used by the launch profile.

The only valid version is "2021-03-31".

setLaunchProfileProtocolVersions

@Stability(value=Stable)
public void setLaunchProfileProtocolVersions(@NotNull
                                                                      List<String> value)

The version number of the protocol that is used by the launch profile.

The only valid version is "2021-03-31".

getName

@Stability(value=Stable)
 @NotNull
public String getName()

A friendly name for the launch profile.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A friendly name for the launch profile.

getStreamConfiguration

@Stability(value=Stable)
 @NotNull
public Object getStreamConfiguration()

A configuration for a streaming session.

setStreamConfiguration

@Stability(value=Stable)
public void setStreamConfiguration(@NotNull
                                                            CfnLaunchProfile.StreamConfigurationProperty value)

A configuration for a streaming session.

setStreamConfiguration

@Stability(value=Stable)
public void setStreamConfiguration(@NotNull
                                                            IResolvable value)

A configuration for a streaming session.

getStudioComponentIds

@Stability(value=Stable)
 @NotNull
public List<String> getStudioComponentIds()

Unique identifiers for a collection of studio components that can be used with this launch profile.

setStudioComponentIds

@Stability(value=Stable)
public void setStudioComponentIds(@NotNull
                                                           List<String> value)

Unique identifiers for a collection of studio components that can be used with this launch profile.

getStudioId

@Stability(value=Stable)
 @NotNull
public String getStudioId()

The unique identifier for a studio resource.

In Nimble Studio , all other resources are contained in a studio resource.

setStudioId

@Stability(value=Stable)
public void setStudioId(@NotNull
                                                 String value)

The unique identifier for a studio resource.

In Nimble Studio , all other resources are contained in a studio resource.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A human-readable description of the launch profile.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A human-readable description of the launch profile.