Package software.amazon.awscdk.services.nimblestudio

Class CfnLaunchProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.nimblestudio.CfnLaunchProfile
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:43:33.863Z") @Stability(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
                 .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrLaunchProfileId()
      The unique identifier for the launch profile resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getEc2SubnetIds

      @Stability(Stable) @NotNull public List<String> getEc2SubnetIds()
      Unique identifiers for a collection of EC2 subnets.

    • setEc2SubnetIds

      @Stability(Stable) public void setEc2SubnetIds(@NotNull List<String> value)
      Unique identifiers for a collection of EC2 subnets.

    • getLaunchProfileProtocolVersions

      @Stability(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(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(Stable) @NotNull public String getName()
      A friendly name for the launch profile.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A friendly name for the launch profile.

    • getStreamConfiguration

      @Stability(Stable) @NotNull public Object getStreamConfiguration()
      A configuration for a streaming session.

    • setStreamConfiguration

      @Stability(Stable) public void setStreamConfiguration(@NotNull CfnLaunchProfile.StreamConfigurationProperty value)
      A configuration for a streaming session.

    • setStreamConfiguration

      @Stability(Stable) public void setStreamConfiguration(@NotNull IResolvable value)
      A configuration for a streaming session.

    • getStudioComponentIds

      @Stability(Stable) @NotNull public List<String> getStudioComponentIds()
      Unique identifiers for a collection of studio components that can be used with this launch profile.

    • setStudioComponentIds

      @Stability(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(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(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(Stable) @Nullable public String getDescription()
      A human-readable description of the launch profile.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A human-readable description of the launch profile.