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:
CfnResourceA CloudFormation
AWS::NimbleStudio::LaunchProfile.The
AWS::NimbleStudio::LaunchProfileresource 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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_depends_on(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_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
addPropertyOverrideor prefixpathwith “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:
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
valueargument toaddOverridewill 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).- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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.
- Return type:
None
- get_att(attribute_name)
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.- Return type:
- 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
- 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
- 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.
- ec2_subnet_ids
Unique identifiers for a collection of EC2 subnets.
- 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”.
- 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.
- node
The construct tree node associated with this construct.
- 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.
- studio_component_ids
Unique identifiers for a collection of studio components that can be used with this launch profile.
- studio_id
The unique identifier for a studio resource.
In Nimble Studio , all other resources are contained in a studio resource.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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)
Return whether the given object is a Construct.
- Parameters:
x (
Any) –- Return type:
bool
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:
objectA 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]) –CfnLaunchProfile.StreamConfigurationProperty.AutomaticTerminationMode.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 theSTOPPEDstate. The default value is 0. The maximum value is 5760. This field is allowed only whensessionPersistenceModeisACTIVATEDandautomaticTerminationModeisACTIVATED. If the value is set to 0, your sessions can’t beSTOPPED. If you then callStopStreamingSession, the session fails. If the time that a session stays in theREADYstate exceeds themaxSessionLengthInMinutesvalue, the session will automatically be terminated (instead ofSTOPPED). If the value is set to a positive number, the session can be stopped. You can callStopStreamingSessionto stop sessions in theREADYstate. If the time that a session stays in theREADYstate exceeds themaxSessionLengthInMinutesvalue, the session will automatically be stopped (instead of terminated).session_backup (
Union[IResolvable,StreamConfigurationSessionBackupProperty,Dict[str,Any],None]) –CfnLaunchProfile.StreamConfigurationProperty.SessionBackup.session_persistence_mode (
Optional[str]) –CfnLaunchProfile.StreamConfigurationProperty.SessionPersistenceMode.session_storage (
Union[IResolvable,StreamConfigurationSessionStorageProperty,Dict[str,Any],None]) – The upload storage for a streaming session.volume_configuration (
Union[IResolvable,VolumeConfigurationProperty,Dict[str,Any],None]) –CfnLaunchProfile.StreamConfigurationProperty.VolumeConfiguration.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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
CfnLaunchProfile.StreamConfigurationProperty.AutomaticTerminationMode.
- clipboard_mode
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
- ec2_instance_types
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
- 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.
- 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
STOPPEDstate.The default value is 0. The maximum value is 5760.
This field is allowed only when
sessionPersistenceModeisACTIVATEDandautomaticTerminationModeisACTIVATED.If the value is set to 0, your sessions can’t be
STOPPED. If you then callStopStreamingSession, the session fails. If the time that a session stays in theREADYstate exceeds themaxSessionLengthInMinutesvalue, the session will automatically be terminated (instead ofSTOPPED).If the value is set to a positive number, the session can be stopped. You can call
StopStreamingSessionto stop sessions in theREADYstate. If the time that a session stays in theREADYstate exceeds themaxSessionLengthInMinutesvalue, the session will automatically be stopped (instead of terminated).
- session_backup
CfnLaunchProfile.StreamConfigurationProperty.SessionBackup.
- session_persistence_mode
CfnLaunchProfile.StreamConfigurationProperty.SessionPersistenceMode.
- session_storage
The upload storage for a streaming session.
- streaming_image_ids
The streaming images that users can select from when launching a streaming session with this launch profile.
- volume_configuration
CfnLaunchProfile.StreamConfigurationProperty.VolumeConfiguration.
StreamConfigurationSessionBackupProperty
- class CfnLaunchProfile.StreamConfigurationSessionBackupProperty(*, max_backups_to_retain=None, mode=None)
Bases:
object- Parameters:
max_backups_to_retain (
Union[int,float,None]) –CfnLaunchProfile.StreamConfigurationSessionBackupProperty.MaxBackupsToRetain.mode (
Optional[str]) –CfnLaunchProfile.StreamConfigurationSessionBackupProperty.Mode.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_nimblestudio as nimblestudio stream_configuration_session_backup_property = nimblestudio.CfnLaunchProfile.StreamConfigurationSessionBackupProperty( max_backups_to_retain=123, mode="mode" )
Attributes
- max_backups_to_retain
CfnLaunchProfile.StreamConfigurationSessionBackupProperty.MaxBackupsToRetain.
- mode
CfnLaunchProfile.StreamConfigurationSessionBackupProperty.Mode.
StreamConfigurationSessionStorageProperty
- class CfnLaunchProfile.StreamConfigurationSessionStorageProperty(*, mode, root=None)
Bases:
objectThe configuration for a streaming session’s upload storage.
- Parameters:
mode (
Sequence[str]) – Allows artists to upload files to their workstations. The only valid option isUPLOAD.root (
Union[IResolvable,StreamingSessionStorageRootProperty,Dict[str,Any],None]) – The configuration for the upload storage root of the streaming session.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- root
The configuration for the upload storage root of the streaming session.
StreamingSessionStorageRootProperty
- class CfnLaunchProfile.StreamingSessionStorageRootProperty(*, linux=None, windows=None)
Bases:
objectThe 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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.
- windows
The folder path in Windows workstations where files are uploaded.
VolumeConfigurationProperty
- class CfnLaunchProfile.VolumeConfigurationProperty(*, iops=None, size=None, throughput=None)
Bases:
object- Parameters:
iops (
Union[int,float,None]) –CfnLaunchProfile.VolumeConfigurationProperty.Iops.size (
Union[int,float,None]) –CfnLaunchProfile.VolumeConfigurationProperty.Size.throughput (
Union[int,float,None]) –CfnLaunchProfile.VolumeConfigurationProperty.Throughput.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_nimblestudio as nimblestudio volume_configuration_property = nimblestudio.CfnLaunchProfile.VolumeConfigurationProperty( iops=123, size=123, throughput=123 )
Attributes
- iops
CfnLaunchProfile.VolumeConfigurationProperty.Iops.
- size
CfnLaunchProfile.VolumeConfigurationProperty.Size.
- throughput
CfnLaunchProfile.VolumeConfigurationProperty.Throughput.