CfnLaunchProfile

class aws_cdk.aws_nimblestudio.CfnLaunchProfile(scope, id, *, ec2_subnet_ids, launch_profile_protocol_versions, name, stream_configuration, studio_component_ids, studio_id, description=None, tags=None)

Bases: CfnResource

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.

CloudformationResource:: AWS::NimbleStudio::LaunchProfile
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

cfn_launch_profile = nimblestudio.CfnLaunchProfile(self, "MyCfnLaunchProfile",
    ec2_subnet_ids=["ec2SubnetIds"],
    launch_profile_protocol_versions=["launchProfileProtocolVersions"],
    name="name",
    stream_configuration=nimblestudio.CfnLaunchProfile.StreamConfigurationProperty(
        clipboard_mode="clipboardMode",
        ec2_instance_types=["ec2InstanceTypes"],
        streaming_image_ids=["streamingImageIds"],

        # the properties below are optional
        automatic_termination_mode="automaticTerminationMode",
        max_session_length_in_minutes=123,
        max_stopped_session_length_in_minutes=123,
        session_backup=nimblestudio.CfnLaunchProfile.StreamConfigurationSessionBackupProperty(
            max_backups_to_retain=123,
            mode="mode"
        ),
        session_persistence_mode="sessionPersistenceMode",
        session_storage=nimblestudio.CfnLaunchProfile.StreamConfigurationSessionStorageProperty(
            mode=["mode"],

            # the properties below are optional
            root=nimblestudio.CfnLaunchProfile.StreamingSessionStorageRootProperty(
                linux="linux",
                windows="windows"
            )
        ),
        volume_configuration=nimblestudio.CfnLaunchProfile.VolumeConfigurationProperty(
            iops=123,
            size=123,
            throughput=123
        )
    ),
    studio_component_ids=["studioComponentIds"],
    studio_id="studioId",

    # the properties below are optional
    description="description",
    tags={
        "tags_key": "tags"
    }
)

Create a new AWS::NimbleStudio::LaunchProfile.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
ec2_subnet_ids (Sequence[str]) – Unique identifiers for a collection of EC2 subnets.
launch_profile_protocol_versions (Sequence[str]) – The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.
name (str) – A friendly name for the launch profile.
stream_configuration (Union[StreamConfigurationProperty, Dict[str, Any], IResolvable]) – A configuration for a streaming session.
studio_component_ids (Sequence[str]) – Unique identifiers for a collection of studio components that can be used with this launch profile.
studio_id (str) – The unique identifier for a studio resource. In Nimble Studio , all other resources are contained in a studio resource.
description (Optional[str]) – A human-readable description of the launch profile.
tags (Optional[Mapping[str, str]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[CfnResource, Stack]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::NimbleStudio::LaunchProfile'

attr_launch_profile_id

The unique identifier for the launch profile resource.

CloudformationAttribute:: LaunchProfileId

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

A human-readable description of the launch profile.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-description

ec2_subnet_ids

Unique identifiers for a collection of EC2 subnets.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-ec2subnetids

launch_profile_protocol_versions

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

The only valid version is “2021-03-31”.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-launchprofileprotocolversions

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

A friendly name for the launch profile.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-name

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

stream_configuration

A configuration for a streaming session.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-streamconfiguration

studio_component_ids

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-studiocomponentids

studio_id

The unique identifier for a studio resource.

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

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-studioid

tags

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

For more information, see Tag .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html#cfn-nimblestudio-launchprofile-tags

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

StreamConfigurationProperty

class CfnLaunchProfile.StreamConfigurationProperty(*, clipboard_mode, ec2_instance_types, streaming_image_ids, automatic_termination_mode=None, max_session_length_in_minutes=None, max_stopped_session_length_in_minutes=None, session_backup=None, session_persistence_mode=None, session_storage=None, volume_configuration=None)

Bases: object

A configuration for a streaming session.

Parameters:

clipboard_mode (str) – Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
ec2_instance_types (Sequence[str]) – The EC2 instance types that users can select from when launching a streaming session with this launch profile.
streaming_image_ids (Sequence[str]) – The streaming images that users can select from when launching a streaming session with this launch profile.
automatic_termination_mode (Optional[str]) – Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state. - When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes . - When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely. This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .
max_session_length_in_minutes (Union[int, float, None]) – The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
max_stopped_session_length_in_minutes (Union[int, float, None]) – Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760. This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED . If the value is set to 0, your sessions can’t be STOPPED . If you then call StopStreamingSession , the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED ). If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
session_backup (Union[StreamConfigurationSessionBackupProperty, Dict[str, Any], IResolvable, None]) – Information about the streaming session backup.
session_persistence_mode (Optional[str]) – Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
session_storage (Union[StreamConfigurationSessionStorageProperty, Dict[str, Any], IResolvable, None]) – The upload storage for a streaming session.
volume_configuration (Union[VolumeConfigurationProperty, Dict[str, Any], IResolvable, None]) – Custom volume configuration for the root volumes that are attached to streaming sessions. This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

stream_configuration_property = nimblestudio.CfnLaunchProfile.StreamConfigurationProperty(
    clipboard_mode="clipboardMode",
    ec2_instance_types=["ec2InstanceTypes"],
    streaming_image_ids=["streamingImageIds"],

    # the properties below are optional
    automatic_termination_mode="automaticTerminationMode",
    max_session_length_in_minutes=123,
    max_stopped_session_length_in_minutes=123,
    session_backup=nimblestudio.CfnLaunchProfile.StreamConfigurationSessionBackupProperty(
        max_backups_to_retain=123,
        mode="mode"
    ),
    session_persistence_mode="sessionPersistenceMode",
    session_storage=nimblestudio.CfnLaunchProfile.StreamConfigurationSessionStorageProperty(
        mode=["mode"],

        # the properties below are optional
        root=nimblestudio.CfnLaunchProfile.StreamingSessionStorageRootProperty(
            linux="linux",
            windows="windows"
        )
    ),
    volume_configuration=nimblestudio.CfnLaunchProfile.VolumeConfigurationProperty(
        iops=123,
        size=123,
        throughput=123
    )
)

Attributes

automatic_termination_mode

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-automaticterminationmode

clipboard_mode

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-clipboardmode

ec2_instance_types

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-ec2instancetypes

max_session_length_in_minutes

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.

After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-maxsessionlengthinminutes

max_stopped_session_length_in_minutes

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state.

The default value is 0. The maximum value is 5760.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED .

If the value is set to 0, your sessions can’t be STOPPED . If you then call StopStreamingSession , the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED ).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-maxstoppedsessionlengthinminutes

session_backup

Information about the streaming session backup.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-sessionbackup

session_persistence_mode

Determine if a streaming session created from this launch profile can configure persistent storage.

This means that volumeConfiguration and automaticTerminationMode are configured.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-sessionpersistencemode

session_storage

The upload storage for a streaming session.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-sessionstorage

streaming_image_ids

The streaming images that users can select from when launching a streaming session with this launch profile.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-streamingimageids

volume_configuration

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html#cfn-nimblestudio-launchprofile-streamconfiguration-volumeconfiguration

StreamConfigurationSessionBackupProperty

class CfnLaunchProfile.StreamConfigurationSessionBackupProperty(*, max_backups_to_retain=None, mode=None)

Bases: object

Configures how streaming sessions are backed up when launched from this launch profile.

Parameters:

max_backups_to_retain (Union[int, float, None]) – The maximum number of backups that each streaming session created from this launch profile can have.
mode (Optional[str]) – Specifies how artists sessions are backed up. Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED , which means that backups are deactivated. To allow backups, set this value to AUTOMATIC .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

stream_configuration_session_backup_property = nimblestudio.CfnLaunchProfile.StreamConfigurationSessionBackupProperty(
    max_backups_to_retain=123,
    mode="mode"
)

Attributes

max_backups_to_retain

The maximum number of backups that each streaming session created from this launch profile can have.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionbackup-maxbackupstoretain

mode

Specifies how artists sessions are backed up.

Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED , which means that backups are deactivated. To allow backups, set this value to AUTOMATIC .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionbackup-mode

StreamConfigurationSessionStorageProperty

class CfnLaunchProfile.StreamConfigurationSessionStorageProperty(*, mode, root=None)

Bases: object

The configuration for a streaming session’s upload storage.

Parameters:

mode (Sequence[str]) – Allows artists to upload files to their workstations. The only valid option is UPLOAD .
root (Union[StreamingSessionStorageRootProperty, Dict[str, Any], IResolvable, None]) – The configuration for the upload storage root of the streaming session.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

stream_configuration_session_storage_property = nimblestudio.CfnLaunchProfile.StreamConfigurationSessionStorageProperty(
    mode=["mode"],

    # the properties below are optional
    root=nimblestudio.CfnLaunchProfile.StreamingSessionStorageRootProperty(
        linux="linux",
        windows="windows"
    )
)

Attributes

mode

Allows artists to upload files to their workstations.

The only valid option is UPLOAD .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionstorage-mode

root

The configuration for the upload storage root of the streaming session.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html#cfn-nimblestudio-launchprofile-streamconfigurationsessionstorage-root

StreamingSessionStorageRootProperty

class CfnLaunchProfile.StreamingSessionStorageRootProperty(*, linux=None, windows=None)

Bases: object

The upload storage root location (folder) on streaming workstations where files are uploaded.

Parameters:

linux (Optional[str]) – The folder path in Linux workstations where files are uploaded.
windows (Optional[str]) – The folder path in Windows workstations where files are uploaded.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingsessionstorageroot.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

streaming_session_storage_root_property = nimblestudio.CfnLaunchProfile.StreamingSessionStorageRootProperty(
    linux="linux",
    windows="windows"
)

Attributes

linux

The folder path in Linux workstations where files are uploaded.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingsessionstorageroot.html#cfn-nimblestudio-launchprofile-streamingsessionstorageroot-linux

windows

The folder path in Windows workstations where files are uploaded.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingsessionstorageroot.html#cfn-nimblestudio-launchprofile-streamingsessionstorageroot-windows

VolumeConfigurationProperty

class CfnLaunchProfile.VolumeConfigurationProperty(*, iops=None, size=None, throughput=None)

Bases: object

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

Parameters:

iops (Union[int, float, None]) – The number of I/O operations per second for the root volume that is attached to streaming session.
size (Union[int, float, None]) – The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.
throughput (Union[int, float, None]) – The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_nimblestudio as nimblestudio

volume_configuration_property = nimblestudio.CfnLaunchProfile.VolumeConfigurationProperty(
    iops=123,
    size=123,
    throughput=123
)

Attributes

iops

The number of I/O operations per second for the root volume that is attached to streaming session.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-iops

size

The size of the root volume that is attached to the streaming session.

The root volume size is measured in GiBs.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-size

throughput

The throughput to provision for the root volume that is attached to the streaming session.

The throughput is measured in MiB/s.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html#cfn-nimblestudio-launchprofile-volumeconfiguration-throughput