SpotEventPluginSettings

class aws_rfdk.deadline.SpotEventPluginSettings(*, aws_instance_status=None, delete_ec2_spot_interrupted_workers=None, delete_sep_terminated_workers=None, enable_resource_tracker=None, idle_shutdown=None, logging_level=None, maximum_instances_started_per_cycle=None, pre_job_task_mode=None, region=None, state=None, strict_hard_cap=None)

Bases: object

The settings of the Spot Event Plugin.

For more details see https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/event-spot.html#event-plugin-configuration-options

Parameters

aws_instance_status (Optional[SpotEventPluginDisplayInstanceStatus]) – The Worker Extra Info column to be used to display AWS Instance Status if the instance has been marked to be stopped or terminated by EC2 or Spot Event Plugin. All timestamps are displayed in UTC format. Default: SpotEventPluginDisplayInstanceStatus.DISABLED
delete_ec2_spot_interrupted_workers (Optional[bool]) – Determines if EC2 Spot interrupted AWS Workers will be deleted from the Workers Panel on the next House Cleaning cycle. Default: false
delete_sep_terminated_workers (Optional[bool]) – Determines if Deadline Spot Event Plugin terminated AWS Workers will be deleted from the Workers Panel on the next House Cleaning cycle. Default: false
enable_resource_tracker (Optional[bool]) – Determines whether the Deadline Resource Tracker should be used. In addition to this property, the Spot Instances deployed by the Spot Event Plugin must also be configured to be tracked by the Resource Tracker using the `trackInstancesWithResourceTracker <https://docs.aws.amazon.com/rfdk/api/latest/docs/aws-rfdk.deadline.SpotEventPluginFleet.html#trackinstanceswithresourcetracker>`_ property of the SpotEventPluginFleet construct, which is true by default. You can set that property to false for fleets that you would like to opt out of the Resource Tracker. See https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/resource-tracker-overview.html Default: true
idle_shutdown (Optional[Duration]) – The length of time that an AWS Worker will wait in a non-rendering state before it is shutdown. Should evenly divide into minutes. Default: Duration.minutes(10)
logging_level (Optional[SpotEventPluginLoggingLevel]) – Spot Event Plugin logging level. Note that Spot Event Plugin adds output to the logs of the render queue and the Workers. Default: SpotEventPluginLoggingLevel.STANDARD
maximum_instances_started_per_cycle (Union[int, float, None]) – The Spot Event Plugin will request this maximum number of instances per House Cleaning cycle. Default: 50
pre_job_task_mode (Optional[SpotEventPluginPreJobTaskMode]) – Determines how the Spot Event Plugin should handle Pre Job Tasks. See https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/job-scripts.html Default: SpotEventPluginPreJobTaskMode.CONSERVATIVE
region (Optional[str]) – The AWS region in which to start the spot fleet request. Default: The region of the Render Queue if it is available; otherwise the region of the current stack.
state (Optional[SpotEventPluginState]) – How the event plug-in should respond to events. Default: SpotEventPluginState.GLOBAL_ENABLED
strict_hard_cap (Optional[bool]) – Determines if any active instances greater than the target capacity for each group will be terminated. Workers may be terminated even while rendering. Default: false

Attributes

aws_instance_status

The Worker Extra Info column to be used to display AWS Instance Status if the instance has been marked to be stopped or terminated by EC2 or Spot Event Plugin.

All timestamps are displayed in UTC format.

Default: SpotEventPluginDisplayInstanceStatus.DISABLED
Return type: Optional[SpotEventPluginDisplayInstanceStatus]

delete_ec2_spot_interrupted_workers

Determines if EC2 Spot interrupted AWS Workers will be deleted from the Workers Panel on the next House Cleaning cycle.

Default: false
Return type: Optional[bool]

delete_sep_terminated_workers

Determines if Deadline Spot Event Plugin terminated AWS Workers will be deleted from the Workers Panel on the next House Cleaning cycle.

Default: false
Return type: Optional[bool]

enable_resource_tracker

Determines whether the Deadline Resource Tracker should be used.

In addition to this property, the Spot Instances deployed by the Spot Event Plugin must also be configured to be tracked by the Resource Tracker using the `trackInstancesWithResourceTracker <https://docs.aws.amazon.com/rfdk/api/latest/docs/aws-rfdk.deadline.SpotEventPluginFleet.html#trackinstanceswithresourcetracker>`_ property of the SpotEventPluginFleet construct, which is true by default. You can set that property to false for fleets that you would like to opt out of the Resource Tracker.

See https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/resource-tracker-overview.html

Default: true
Return type: Optional[bool]

idle_shutdown

The length of time that an AWS Worker will wait in a non-rendering state before it is shutdown.

Should evenly divide into minutes.

Default: Duration.minutes(10)
Return type: Optional[Duration]

logging_level

Spot Event Plugin logging level.

Note that Spot Event Plugin adds output to the logs of the render queue and the Workers.

Default: SpotEventPluginLoggingLevel.STANDARD
Return type: Optional[SpotEventPluginLoggingLevel]

maximum_instances_started_per_cycle

The Spot Event Plugin will request this maximum number of instances per House Cleaning cycle.

Default: 50
Return type: Union[int, float, None]

pre_job_task_mode

Determines how the Spot Event Plugin should handle Pre Job Tasks.

See https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/job-scripts.html

Default: SpotEventPluginPreJobTaskMode.CONSERVATIVE
Return type: Optional[SpotEventPluginPreJobTaskMode]

region

The AWS region in which to start the spot fleet request.

Default: The region of the Render Queue if it is available; otherwise the region of the current stack.
Return type: Optional[str]

state

How the event plug-in should respond to events.

Default: SpotEventPluginState.GLOBAL_ENABLED
Return type: Optional[SpotEventPluginState]

strict_hard_cap

Determines if any active instances greater than the target capacity for each group will be terminated.

Workers may be terminated even while rendering.

Default: false
Return type: Optional[bool]