WorkerInstanceConfigurationProps

class aws_rfdk.deadline.WorkerInstanceConfigurationProps(*, worker, cloud_watch_log_settings=None, render_queue=None, should_install_cloud_watch_agent=None, user_data_provider=None, worker_settings=None)

Bases: object

Properties for a WorkerInstanceConfiguration.

Parameters:

worker (IHost) – The Deadline Worker that should be configured.
cloud_watch_log_settings (Union[LogGroupFactoryProps, Dict[str, Any], None]) – The configuration for streaming the Deadline Worker logs to AWS CloudWatch. Default: The Worker logs will not be streamed to CloudWatch.
render_queue (Optional[IRenderQueue]) – The RenderQueue that the worker should be configured to connect to. Default: The Worker is not configured to connect to a RenderQueue
should_install_cloud_watch_agent (Optional[bool]) – Whether or not the CloudWatch agent should be automatically installed onto all worker instances. This installation will be a best effort, but will not fail the deployment if it isn’t completed successfully. Ideally the CloudWatch agent should be installed on the AMI to avoid issues. If the installation fails, logs will not be streamed off of the workers into CloudWatch. Default: true
user_data_provider (Optional[IInstanceUserDataProvider]) – An optional provider of user data commands to be injected at various points during the Worker configuration lifecycle. You can provide a subclass of InstanceUserDataProvider with the methods overridden as desired.
worker_settings (Union[WorkerSettings, Dict[str, Any], None]) – The settings to apply to the Deadline Worker. Default: The Worker is assigned the default settings as outlined in the WorkerSettings interface.

Attributes

cloud_watch_log_settings

The configuration for streaming the Deadline Worker logs to AWS CloudWatch.

Default:: The Worker logs will not be streamed to CloudWatch.

render_queue

The RenderQueue that the worker should be configured to connect to.

Default:: The Worker is not configured to connect to a RenderQueue

should_install_cloud_watch_agent

Whether or not the CloudWatch agent should be automatically installed onto all worker instances.

This installation will be a best effort, but will not fail the deployment if it isn’t completed successfully. Ideally the CloudWatch agent should be installed on the AMI to avoid issues. If the installation fails, logs will not be streamed off of the workers into CloudWatch.

Default:: true

user_data_provider

An optional provider of user data commands to be injected at various points during the Worker configuration lifecycle.

You can provide a subclass of InstanceUserDataProvider with the methods overridden as desired.

worker: The Deadline Worker that should be configured.

worker_settings

The settings to apply to the Deadline Worker.

Default:: The Worker is assigned the default settings as outlined in the WorkerSettings interface.