SpotEventPluginFleetProps

class aws_rfdk.deadline.SpotEventPluginFleetProps(*, deadline_groups, instance_types, max_capacity, render_queue, vpc, worker_machine_image, allocation_strategy=None, block_devices=None, deadline_pools=None, deadline_region=None, fleet_instance_role=None, fleet_role=None, key_name=None, log_group_props=None, security_groups=None, track_instances_with_resource_tracker=None, user_data=None, user_data_provider=None, valid_until=None, vpc_subnets=None)

Bases: object

Properties for the Spot Event Plugin Worker Fleet.

Parameters:

deadline_groups (Sequence[str]) – Deadline groups these workers need to be assigned to. Also, note that the Spot Fleet configuration does not allow using wildcards as part of the Group name as described here https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/event-spot.html#wildcards
instance_types (Sequence[InstanceType]) – Types of instances to launch.
max_capacity (Union[int, float]) – The the maximum capacity that the Spot Fleet can grow to. See https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/event-spot.html#spot-fleet-requests
render_queue (IRenderQueue) – The RenderQueue that Worker fleet should connect to.
vpc (IVpc) – VPC to launch the Worker fleet in.
worker_machine_image (IMachineImage) – The AMI of the Deadline Worker to launch.
allocation_strategy (Optional[SpotFleetAllocationStrategy]) – Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request. Default: - SpotFleetAllocationStrategy.LOWEST_PRICE.
block_devices (Optional[Sequence[Union[BlockDevice, Dict[str, Any]]]]) – The Block devices that will be attached to your workers. Default: - The default devices of the provided ami will be used.
deadline_pools (Optional[Sequence[str]]) – Deadline pools these workers need to be assigned to. Default: - Workers are not assigned to any pool.
deadline_region (Optional[str]) – Deadline region these workers needs to be assigned to. Note that this is not an AWS region but a Deadline region used for path mapping. See https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/cross-platform.html#regions Default: - Worker is not assigned to any Deadline region.
fleet_instance_role (Optional[IRole]) – An IAM role to associate with the instance profile assigned to its resources. Create this role on the same stack with the SpotEventPluginFleet to avoid circular dependencies. The role must be assumable by the service principal ec2.amazonaws.com and have AWSThinkboxDeadlineSpotEventPluginWorkerPolicy policy attached:: const role = new iam.Role(this, ‘MyRole’, { assumedBy: new iam.ServicePrincipal(‘ec2.amazonaws.com’), managedPolicies: [ ManagedPolicy.fromAwsManagedPolicyName(‘AWSThinkboxDeadlineSpotEventPluginWorkerPolicy’), ], }); Default: - A role will automatically be created.
fleet_role (Optional[IRole]) – An IAM role for the spot fleet. The role must be assumable by the service principal spotfleet.amazonaws.com and have AmazonEC2SpotFleetTaggingRole policy attached Example:: const role = new iam.Role(this, ‘FleetRole’, { assumedBy: new iam.ServicePrincipal(‘spotfleet.amazonaws.com’), managedPolicies: [ ManagedPolicy.fromAwsManagedPolicyName(‘service-role/AmazonEC2SpotFleetTaggingRole’), ], }); Default: - A role will automatically be created.
key_name (Optional[str]) – Name of SSH keypair to grant access to instances. 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/”.
security_groups (Optional[Sequence[ISecurityGroup]]) – Security Groups to assign to this fleet. Default: - A new security group will be created automatically.
track_instances_with_resource_tracker (Optional[bool]) – Whether the instances in the Spot Fleet should be tracked by Deadline Resource Tracker. In addition to this property, the Spot Event Plugin must also be configured to use the Resource tracker by using the `enableResourceTracker <https://docs.aws.amazon.com/rfdk/api/latest/docs/aws-rfdk.deadline.SpotEventPluginSettings.html#enableresourcetracker>`_ property of the ConfigureSpotEventPlugin construct, which is true by default. Default: true
user_data (Optional[UserData]) – User data that instances use when starting up. Default: - User data will be created automatically.
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. Default: : Not used.
valid_until (Optional[Expiration]) – The end date and time of the request. After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. Default: - the Spot Fleet request remains until you cancel it.
vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – Where to place the instance within the VPC. Default: - Private subnets.

Attributes

allocation_strategy

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

Default:

SpotFleetAllocationStrategy.LOWEST_PRICE.

block_devices

The Block devices that will be attached to your workers.

Default:

The default devices of the provided ami will be used.

deadline_groups

Deadline groups these workers need to be assigned to.

Also, note that the Spot Fleet configuration does not allow using wildcards as part of the Group name as described here https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/event-spot.html#wildcards

deadline_pools

Deadline pools these workers need to be assigned to.

Default:

Workers are not assigned to any pool.

deadline_region

Deadline region these workers needs to be assigned to.

Note that this is not an AWS region but a Deadline region used for path mapping. See https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/cross-platform.html#regions

Default:

Worker is not assigned to any Deadline region.

fleet_instance_role

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

Create this role on the same stack with the SpotEventPluginFleet to avoid circular dependencies.

The role must be assumable by the service principal ec2.amazonaws.com and have AWSThinkboxDeadlineSpotEventPluginWorkerPolicy policy attached:

const role = new iam.Role(this, 'MyRole', {
  assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com'),
  managedPolicies: [
    ManagedPolicy.fromAwsManagedPolicyName('AWSThinkboxDeadlineSpotEventPluginWorkerPolicy'),
  ],
});

Default:

A role will automatically be created.

fleet_role

An IAM role for the spot fleet.

The role must be assumable by the service principal spotfleet.amazonaws.com and have AmazonEC2SpotFleetTaggingRole policy attached Example:

const role = new iam.Role(this, 'FleetRole', {
  assumedBy: new iam.ServicePrincipal('spotfleet.amazonaws.com'),
  managedPolicies: [
    ManagedPolicy.fromAwsManagedPolicyName('service-role/AmazonEC2SpotFleetTaggingRole'),
  ],
});

Default:

A role will automatically be created.

instance_types: Types of instances to launch.

key_name

Name of SSH keypair to grant access to instances.

Default:

No SSH access will be possible.

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/”.

max_capacity

The the maximum capacity that the Spot Fleet can grow to.

See https://docs.thinkboxsoftware.com/products/deadline/10.2/1_User%20Manual/manual/event-spot.html#spot-fleet-requests

render_queue: The RenderQueue that Worker fleet should connect to.

security_groups

Security Groups to assign to this fleet.

Default:

A new security group will be created automatically.

track_instances_with_resource_tracker

Whether the instances in the Spot Fleet should be tracked by Deadline Resource Tracker.

In addition to this property, the Spot Event Plugin must also be configured to use the Resource tracker by using the `enableResourceTracker <https://docs.aws.amazon.com/rfdk/api/latest/docs/aws-rfdk.deadline.SpotEventPluginSettings.html#enableresourcetracker>`_ property of the ConfigureSpotEventPlugin construct, which is true by default.

Default:: true

user_data

User data that instances use when starting up.

Default:

User data will be created automatically.

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.

Default:: : Not used.

valid_until

The end date and time of the request.

After the end date and time, no new Spot Instance requests are placed or able to fulfill the request.

Default:

the Spot Fleet request remains until you cancel it.

vpc: VPC to launch the Worker fleet in.

vpc_subnets

Where to place the instance within the VPC.

Default:

Private subnets.

worker_machine_image: The AMI of the Deadline Worker to launch.