WorkerInstanceFleetProps

class aws_rfdk.deadline.WorkerInstanceFleetProps(*, groups=None, listener_port=None, pools=None, region=None, render_queue, vpc, worker_machine_image, block_devices=None, desired_capacity=None, health_check_config=None, health_monitor=None, instance_type=None, key_name=None, log_group_props=None, max_capacity=None, min_capacity=None, role=None, security_group=None, spot_price=None, user_data=None, user_data_provider=None, vpc_subnets=None)

Bases: aws_rfdk.deadline.WorkerSettings

Properties for the Deadline Worker Fleet.

Parameters

  • groups (Optional[Sequence[str]]) – Deadline groups these workers needs to be assigned to. The group is created if it does not already exist. Default: - Worker is not assigned to any group

  • listener_port (Union[int, float, None]) – The port to configure the worker to listen on for remote commands such as requests for its log stream. If more than one worker is present on a single host, connsecutive ports will be opened, starting with the supplied port, up to the maximum number of workers defined by the WorkerInstanceFleet. Default: 56032

  • pools (Optional[Sequence[str]]) – Deadline pools these workers needs to be assigned to. The pool is created if it does not already exist. Default: - Worker is not assigned to any pool.

  • region (Optional[str]) – Deadline region these workers needs to be assigned to. Default: - Worker is not assigned to any region

  • render_queue (IRenderQueue) – Endpoint for the RenderQueue, to which the worker fleet needs to be connected.

  • vpc (IVpc) – VPC to launch the worker fleet in.

  • worker_machine_image (IMachineImage) – AMI of the deadline worker to launch.

  • block_devices (Optional[Sequence[Union[BlockDevice, Dict[str, Any]]]]) –

  • desired_capacity (Union[int, float, None]) – Initial amount of workers in the fleet. If this is set to a number, every deployment will reset the amount of workers to this number. It is recommended to leave this value blank. Default: minCapacity, and leave unchanged during deployment

  • health_check_config (Union[HealthCheckConfig, Dict[str, Any], None]) – Properties for configuring a health check. Note: The health-check feature is supported with Deadline Client v10.1.9 and later. Default: properties of HealthCheckConfig applies

  • health_monitor (Optional[IHealthMonitor]) – Health Monitor component to monitor the health of instances. Note: The health-check feature is supported with Deadline Client v10.1.9 and later. Default: - Health Monitoring is turned-off

  • instance_type (Optional[InstanceType]) – Type of instance to launch for executing repository installer. Default: - a T2-Large type will be used.

  • key_name (Optional[str]) – Name of SSH keypair to grant access to instance. Default: - No SSH access will be possible.

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

  • max_capacity (Union[int, float, None]) – Maximum number of instances in the fleet. Default: desiredCapacity, or minCapacity if desiredCapacity is not set

  • min_capacity (Union[int, float, None]) – Minimum number of instances in the fleet. Default: 1

  • role (Optional[IRole]) – An IAM role to associate with the instance profile assigned to its resources. The role must be assumable by the service principal ec2.amazonaws.com: const role = new iam.Role(this, ‘MyRole’, { assumedBy: new iam.ServicePrincipal(‘ec2.amazonaws.com’) }); Default: - A role will automatically be created, it can be accessed via the role property

  • security_group (Optional[ISecurityGroup]) – Security Group to assign to this fleet. Default: - create new security group

  • spot_price (Union[int, float, None]) – The maximum hourly price($) to be paid for each Spot instance. min - 0.001; max - 255 Default: - launches on-demand EC2 instances.

  • user_data (Optional[UserData]) – The specific UserData to use. The UserData will be mutated by this construct and may be mutated afterwards as well. Default: A UserData object appropriate for the MachineImage’s Operating System is created.

  • 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.

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

Attributes

block_devices
Return type

Optional[List[BlockDevice]]

desired_capacity

Initial amount of workers in the fleet.

If this is set to a number, every deployment will reset the amount of workers to this number. It is recommended to leave this value blank.

Default

minCapacity, and leave unchanged during deployment

Return type

Union[int, float, None]

groups

Deadline groups these workers needs to be assigned to.

The group is created if it does not already exist.

Default

  • Worker is not assigned to any group

Return type

Optional[List[str]]

health_check_config

Properties for configuring a health check.

Note: The health-check feature is supported with Deadline Client v10.1.9 and later.

Default

properties of HealthCheckConfig applies

Return type

Optional[HealthCheckConfig]

health_monitor

Health Monitor component to monitor the health of instances.

Note: The health-check feature is supported with Deadline Client v10.1.9 and later.

Default

  • Health Monitoring is turned-off

Return type

Optional[IHealthMonitor]

instance_type

Type of instance to launch for executing repository installer.

Default

  • a T2-Large type will be used.

Return type

Optional[InstanceType]

key_name

Name of SSH keypair to grant access to instance.

Default

  • No SSH access will be possible.

Return type

Optional[str]

listener_port

The port to configure the worker to listen on for remote commands such as requests for its log stream.

If more than one worker is present on a single host, connsecutive ports will be opened, starting with the supplied port, up to the maximum number of workers defined by the WorkerInstanceFleet.

Default

56032

Return type

Union[int, float, None]

log_group_props

Properties for setting up the Deadline Worker’s LogGroup.

Default

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

Return type

Optional[LogGroupFactoryProps]

max_capacity

Maximum number of instances in the fleet.

Default

desiredCapacity, or minCapacity if desiredCapacity is not set

Return type

Union[int, float, None]

min_capacity

Minimum number of instances in the fleet.

Default

1

Return type

Union[int, float, None]

pools

Deadline pools these workers needs to be assigned to.

The pool is created if it does not already exist.

Default

  • Worker is not assigned to any pool.

Return type

Optional[List[str]]

region

Deadline region these workers needs to be assigned to.

Default

  • Worker is not assigned to any region

Return type

Optional[str]

render_queue

Endpoint for the RenderQueue, to which the worker fleet needs to be connected.

Return type

IRenderQueue

role

An IAM role to associate with the instance profile assigned to its resources.

The role must be assumable by the service principal ec2.amazonaws.com:

const role = new iam.Role(this, ‘MyRole’, { assumedBy: new iam.ServicePrincipal(‘ec2.amazonaws.com’) });

Default

  • A role will automatically be created, it can be accessed via the role property

Return type

Optional[IRole]

security_group

Security Group to assign to this fleet.

Default

  • create new security group

Return type

Optional[ISecurityGroup]

spot_price

The maximum hourly price($) to be paid for each Spot instance.

min - 0.001; max - 255

Default

  • launches on-demand EC2 instances.

Return type

Union[int, float, None]

user_data

The specific UserData to use.

The UserData will be mutated by this construct and may be mutated afterwards as well.

Default

A UserData object appropriate for the MachineImage’s Operating System is created.

Return type

Optional[UserData]

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.

Return type

Optional[IInstanceUserDataProvider]

vpc

VPC to launch the worker fleet in.

Return type

IVpc

vpc_subnets

Where to place the instance within the VPC.

Default

  • Private subnets.

Return type

Optional[SubnetSelection]

worker_machine_image

AMI of the deadline worker to launch.

Return type

IMachineImage