RenderQueueProps

class aws_rfdk.deadline.RenderQueueProps(*, images, repository, version, vpc, access_logs=None, deletion_protection=None, enable_local_file_caching=None, health_check_config=None, hostname=None, instance_type=None, log_group_props=None, render_queue_size=None, security_groups=None, traffic_encryption=None, vpc_subnets=None, vpc_subnets_alb=None)

Bases: object

Properties for the Render Queue.

Parameters

  • images (Union[RenderQueueImages, Dict[str, Any]]) – A collection of Docker container images used to run the RenderQueue.

  • repository (IRepository) – The Deadline Repository which the RCS instances will create a direct connection to.

  • version (IVersion) – The Deadline Client version that will be running within this RenderQueue.

  • vpc (IVpc) – VPC to launch the Render Queue in.

  • access_logs (Union[RenderQueueAccessLogProps, Dict[str, Any], None]) – Properties for configuring access logging for the load balancer used by the Render Queue. This is disabled by default, but it is highly recommended to enable it to allow engineers to identify and root cause incidents such as unauthorized access. Default: - Access logging is disabled

  • deletion_protection (Optional[bool]) – Indicates whether deletion protection is enabled for the LoadBalancer. Default: true Note: This value is true by default which means that the deletion protection is enabled for the load balancer. Hence, user needs to disable it using AWS Console or CLI before deleting the stack.

  • enable_local_file_caching (Optional[bool]) – If enabled, then Linux’s cachefilesd will be installed and set to running on the ECS container host for the Deadline Remote Connection Server. This can reduce the amount of read throughput required for the Repository Filesystem. For more information, please see: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/storage_administration_guide/ch-fscache Note: If enabling this, then your Repository filesystem may require additional mount options to take advantage. Not every filesystem’s driver supports integration with cachefilesd. e.g. NFS and Amazon EFS do support it, and require the ‘fsc’ mount option be provided. Note2: Your ECS container host will require access to port 80 on the regional S3 service when enabling this option so that it can install cachefilesd. This host is based on Amazon Linux 2, and the package repository for these systems is hosted on S3 and reached via port 80. Default: false

  • health_check_config (Union[RenderQueueHealthCheckConfiguration, Dict[str, Any], None]) – Configuration for the health checks performed by the RenderQueue upon the Deadline RCS. Default: The values outlined in {@link RenderQueueHealthCheckConfiguration }

  • hostname (Union[RenderQueueHostNameProps, Dict[str, Any], None]) – Hostname to use to connect to the RenderQueue. Default: - The hostname renderqueue will be used and a PrivateHostedZone will be created with the domain name aws-rfdk.com

  • instance_type (Optional[InstanceType]) – The type of instance on which each Deadline RCS will run. Default: c5.Large instances will be launched.

  • log_group_props (Union[LogGroupFactoryProps, Dict[str, Any], None]) – Properties for setting up the Render Queue’s LogGroup. Default: - LogGroup will be created with all properties’ default values and a prefix of “/renderfarm/”.

  • render_queue_size (Union[RenderQueueSizeConstraints, Dict[str, Any], None]) – Constraints on the number of Deadline RCS processes that can be run as part of this RenderQueue. Default: Allow no less than one Deadline RCS to be running.

  • security_groups (Union[RenderQueueSecurityGroups, Dict[str, Any], None]) – Security groups to use for the Render Queue. Default: - new security groups are created

  • traffic_encryption (Union[RenderQueueTrafficEncryptionProps, Dict[str, Any], None]) – Whether or not network traffic to the RenderQueue should be encrypted. Enabling this requires that all Deadline clients connect with TLS. Default: traffic is encrypted between Clients and the Render Queue and between its components

  • vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – Where to place instances within the VPC. Default: - All Private subnets.

  • vpc_subnets_alb (Union[SubnetSelection, Dict[str, Any], None]) – The subnets into which to place the Application Load Balancer that is deployed. Default: - One Private subnet from each AZ.

Attributes

access_logs

Properties for configuring access logging for the load balancer used by the Render Queue.

This is disabled by default, but it is highly recommended to enable it to allow engineers to identify and root cause incidents such as unauthorized access.

Default

  • Access logging is disabled

Return type

Optional[RenderQueueAccessLogProps]

deletion_protection

Indicates whether deletion protection is enabled for the LoadBalancer.

Default

true

Note: This value is true by default which means that the deletion protection is enabled for the load balancer. Hence, user needs to disable it using AWS Console or CLI before deleting the stack.

See

https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#deletion-protection

Return type

Optional[bool]

enable_local_file_caching

If enabled, then Linux’s cachefilesd will be installed and set to running on the ECS container host for the Deadline Remote Connection Server.

This can reduce the amount of read throughput required for the Repository Filesystem.

For more information, please see: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/storage_administration_guide/ch-fscache

Note: If enabling this, then your Repository filesystem may require additional mount options to take advantage. Not every filesystem’s driver supports integration with cachefilesd. e.g. NFS and Amazon EFS do support it, and require the ‘fsc’ mount option be provided.

Note2: Your ECS container host will require access to port 80 on the regional S3 service when enabling this option so that it can install cachefilesd. This host is based on Amazon Linux 2, and the package repository for these systems is hosted on S3 and reached via port 80.

Default

false

Return type

Optional[bool]

health_check_config

Configuration for the health checks performed by the RenderQueue upon the Deadline RCS.

Default

The values outlined in {@link RenderQueueHealthCheckConfiguration }

Return type

Optional[RenderQueueHealthCheckConfiguration]

hostname

Hostname to use to connect to the RenderQueue.

Default

  • The hostname renderqueue will be used and a PrivateHostedZone will be created with the domain name aws-rfdk.com

Return type

Optional[RenderQueueHostNameProps]

images

A collection of Docker container images used to run the RenderQueue.

Return type

RenderQueueImages

instance_type

The type of instance on which each Deadline RCS will run.

Default

c5.Large instances will be launched.

Return type

Optional[InstanceType]

log_group_props

Properties for setting up the Render Queue’s LogGroup.

Default

  • LogGroup will be created with all properties’ default values and a prefix of “/renderfarm/”.

Return type

Optional[LogGroupFactoryProps]

render_queue_size

Constraints on the number of Deadline RCS processes that can be run as part of this RenderQueue.

Default

Allow no less than one Deadline RCS to be running.

Return type

Optional[RenderQueueSizeConstraints]

repository

The Deadline Repository which the RCS instances will create a direct connection to.

Return type

IRepository

security_groups

Security groups to use for the Render Queue.

Default

  • new security groups are created

Return type

Optional[RenderQueueSecurityGroups]

traffic_encryption

Whether or not network traffic to the RenderQueue should be encrypted.

Enabling this requires that all Deadline clients connect with TLS.

Default

traffic is encrypted between Clients and the Render Queue and between its components

Return type

Optional[RenderQueueTrafficEncryptionProps]

version

The Deadline Client version that will be running within this RenderQueue.

Return type

IVersion

vpc

VPC to launch the Render Queue in.

Return type

IVpc

vpc_subnets

Where to place instances within the VPC.

Default

  • All Private subnets.

Return type

Optional[SubnetSelection]

vpc_subnets_alb

The subnets into which to place the Application Load Balancer that is deployed.

Default

  • One Private subnet from each AZ.

Return type

Optional[SubnetSelection]