fleets

Creates, updates, deletes, gets or lists a fleets resource.

Overview

Name	fleets
Type	Resource
Id	aws.deadline.fleets

Fields

The following fields are returned by SELECT queries:

get_fleet

Name	Datatype	Description
auto_scaling_status	string	The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING. (GROWING, STEADY, SHRINKING)
capabilities	object	Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
configuration	object	Fleet configuration details.
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
description	string	The description of the fleet. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
display_name	string	The display name of the fleet. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
farm_id	string	The farm ID of the farm in the fleet. (pattern: <code>farm-[0-9a-f]{32}</code>)
fleet_id	string	The fleet ID. (pattern: <code>fleet-[0-9a-f]{32}</code>)
host_configuration	object	Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string ("").
max_worker_count	integer	The maximum number of workers specified in the fleet.
min_worker_count	integer	The minimum number of workers specified in the fleet.
role_arn	string	The IAM role ARN. (pattern: <code>arn:(aws[a-zA-Z-]):iam::\d{12}:role(/[!-.0-~]+)/[\w+=,.@-]+</code>)
status	string	The status of the fleet. (ACTIVE, CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, CREATE_FAILED, UPDATE_FAILED, SUSPENDED)
status_message	string	A message that communicates a suspended status of the fleet.
target_worker_count	integer	The number of target workers in the fleet.
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.
worker_count	integer	The number of workers in the fleet.

list_fleets

Name	Datatype	Description
auto_scaling_status	string	The Auto Scaling status of a fleet. (GROWING, STEADY, SHRINKING)
configuration	object	Fleet configuration details.
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
display_name	string	The display name of the fleet summary to update. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
farm_id	string	The farm ID. (pattern: <code>farm-[0-9a-f]{32}</code>)
fleet_id	string	The fleet ID. (pattern: <code>fleet-[0-9a-f]{32}</code>)
max_worker_count	integer	The maximum number of workers specified in the fleet.
min_worker_count	integer	The minimum number of workers in the fleet.
status	string	The status of the fleet. (ACTIVE, CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, CREATE_FAILED, UPDATE_FAILED, SUSPENDED)
status_message	string	A message that communicates a suspended status of the fleet.
target_worker_count	integer	The target number of workers in a fleet.
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.
worker_count	integer	The number of workers in the fleet summary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_fleet	select	farm_id, fleet_id, region		Get a fleet.
list_fleets	select	farm_id, region	nextToken, maxResults, principalId, displayName, status	Lists fleets.
create_fleet	insert	farm_id, region, displayName, roleArn, maxWorkerCount, configuration	X-Amz-Client-Token	Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.
associate_member_to_fleet	update	farm_id, fleet_id, principal_id, region, principalType, identityStoreId, membershipLevel		Assigns a fleet membership level to a member.
disassociate_member_from_fleet	update	farm_id, fleet_id, principal_id, region		Disassociates a member from a fleet.
update_fleet	update	farm_id, fleet_id, region	X-Amz-Client-Token	Updates a fleet.
delete_fleet	delete	farm_id, fleet_id, region	X-Amz-Client-Token	Deletes a fleet.
assume_fleet_role_for_read	exec	farm_id, fleet_id, region		Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
farm_id	string	The farm ID for the fleet's farm.
fleet_id	string	The fleet ID.
principal_id	string	A member's principal ID to disassociate from a fleet.
region	string	AWS region (default: us-east-1)
X-Amz-Client-Token	string	The unique token which the server uses to recognize retries of the same request.
displayName	string	The display names of a list of fleets. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.
principalId	string	The principal ID of the members to include in the fleet.
status	string	The status of the fleet.

SELECT examples

get_fleet

Get a fleet.

SELECT
auto_scaling_status,
capabilities,
configuration,
created_at,
created_by,
description,
display_name,
farm_id,
fleet_id,
host_configuration,
max_worker_count,
min_worker_count,
role_arn,
status,
status_message,
target_worker_count,
updated_at,
updated_by,
worker_count
FROM aws.deadline.fleets
WHERE farm_id = '{{ farm_id }}' -- required
AND fleet_id = '{{ fleet_id }}' -- required
AND region = '{{ region }}' -- required
;

list_fleets

Lists fleets.

SELECT
auto_scaling_status,
configuration,
created_at,
created_by,
display_name,
farm_id,
fleet_id,
max_worker_count,
min_worker_count,
status,
status_message,
target_worker_count,
updated_at,
updated_by,
worker_count
FROM aws.deadline.fleets
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND principalId = '{{ principalId }}'
AND displayName = '{{ displayName }}'
AND status = '{{ status }}'
;

INSERT examples

create_fleet

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

INSERT INTO aws.deadline.fleets (
displayName,
description,
roleArn,
minWorkerCount,
maxWorkerCount,
configuration,
tags,
hostConfiguration,
farm_id,
region,
`X-Amz-Client-Token`
)
SELECT 
'{{ displayName }}' /* required */,
'{{ description }}',
'{{ roleArn }}' /* required */,
{{ minWorkerCount }},
{{ maxWorkerCount }} /* required */,
'{{ configuration }}' /* required */,
'{{ tags }}',
'{{ hostConfiguration }}',
'{{ farm_id }}',
'{{ region }}',
'{{ X-Amz-Client-Token }}'
RETURNING
fleet_id
;

Manifest

# Description fields are for documentation purposes
- name: fleets
props:
  - name: farm_id
    value: "{{ farm_id }}"
    description: Required parameter for the fleets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the fleets resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: minWorkerCount
    value: {{ minWorkerCount }}
  - name: maxWorkerCount
    value: {{ maxWorkerCount }}
  - name: configuration
    description: |
      Fleet configuration details.
    value:
      customerManaged:
        mode: "{{ mode }}"
        autoScalingConfiguration:
          standbyWorkerCount: {{ standbyWorkerCount }}
          workerIdleDurationSeconds: {{ workerIdleDurationSeconds }}
          scaleOutWorkersPerMinute: {{ scaleOutWorkersPerMinute }}
        workerCapabilities:
          vCpuCount:
            min: {{ min }}
            max: {{ max }}
          memoryMiB:
            min: {{ min }}
            max: {{ max }}
          acceleratorTypes:
            - "{{ acceleratorTypes }}"
          acceleratorCount:
            min: {{ min }}
            max: {{ max }}
          acceleratorTotalMemoryMiB:
            min: {{ min }}
            max: {{ max }}
          osFamily: "{{ osFamily }}"
          cpuArchitectureType: "{{ cpuArchitectureType }}"
          customAmounts:
            - name: "{{ name }}"
              min: {{ min }}
              max: {{ max }}
          customAttributes:
            - name: "{{ name }}"
              values: "{{ values }}"
        storageProfileId: "{{ storageProfileId }}"
        tagPropagationMode: "{{ tagPropagationMode }}"
      serviceManagedEc2:
        instanceCapabilities:
          vCpuCount:
            min: {{ min }}
            max: {{ max }}
          memoryMiB:
            min: {{ min }}
            max: {{ max }}
          osFamily: "{{ osFamily }}"
          cpuArchitectureType: "{{ cpuArchitectureType }}"
          rootEbsVolume:
            sizeGiB: {{ sizeGiB }}
            iops: {{ iops }}
            throughputMiB: {{ throughputMiB }}
          acceleratorCapabilities:
            selections:
              - name: "{{ name }}"
                runtime: "{{ runtime }}"
            count:
              min: {{ min }}
              max: {{ max }}
          allowedInstanceTypes:
            - "{{ allowedInstanceTypes }}"
          excludedInstanceTypes:
            - "{{ excludedInstanceTypes }}"
          customAmounts:
            - name: "{{ name }}"
              min: {{ min }}
              max: {{ max }}
          customAttributes:
            - name: "{{ name }}"
              values: "{{ values }}"
        instanceMarketOptions:
          type_: "{{ type_ }}"
        vpcConfiguration:
          resourceConfigurationArns:
            - "{{ resourceConfigurationArns }}"
        storageProfileId: "{{ storageProfileId }}"
        persistentVolumeConfiguration:
          sizeGiB: {{ sizeGiB }}
          iops: {{ iops }}
          throughputMiB: {{ throughputMiB }}
          mountPath: "{{ mountPath }}"
          lastUsedTtlHours: {{ lastUsedTtlHours }}
        autoScalingConfiguration:
          standbyWorkerCount: {{ standbyWorkerCount }}
          workerIdleDurationSeconds: {{ workerIdleDurationSeconds }}
          scaleOutWorkersPerMinute: {{ scaleOutWorkersPerMinute }}
  - name: tags
    value: "{{ tags }}"
  - name: hostConfiguration
    description: |
      Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string ("").
    value:
      scriptBody: "{{ scriptBody }}"
      scriptTimeoutSeconds: {{ scriptTimeoutSeconds }}
  - name: X-Amz-Client-Token
    value: "{{ X-Amz-Client-Token }}"
    description: The unique token which the server uses to recognize retries of the same request.
    description: The unique token which the server uses to recognize retries of the same request.

UPDATE examples

associate_member_to_fleet

Assigns a fleet membership level to a member.

UPDATE aws.deadline.fleets
SET 
principalType = '{{ principalType }}',
identityStoreId = '{{ identityStoreId }}',
membershipLevel = '{{ membershipLevel }}',
identityCenterRegion = '{{ identityCenterRegion }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND fleet_id = '{{ fleet_id }}' --required
AND principal_id = '{{ principal_id }}' --required
AND region = '{{ region }}' --required
AND principalType = '{{ principalType }}' --required
AND identityStoreId = '{{ identityStoreId }}' --required
AND membershipLevel = '{{ membershipLevel }}' --required;

disassociate_member_from_fleet

Disassociates a member from a fleet.

UPDATE aws.deadline.fleets
SET 
-- No updatable properties
WHERE 
farm_id = '{{ farm_id }}' --required
AND fleet_id = '{{ fleet_id }}' --required
AND principal_id = '{{ principal_id }}' --required
AND region = '{{ region }}' --required;

update_fleet

Updates a fleet.

UPDATE aws.deadline.fleets
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
roleArn = '{{ roleArn }}',
minWorkerCount = {{ minWorkerCount }},
maxWorkerCount = {{ maxWorkerCount }},
configuration = '{{ configuration }}',
hostConfiguration = '{{ hostConfiguration }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND fleet_id = '{{ fleet_id }}' --required
AND region = '{{ region }}' --required
AND `X-Amz-Client-Token` = '{{ X-Amz-Client-Token}}';

DELETE examples

delete_fleet

Deletes a fleet.

DELETE FROM aws.deadline.fleets
WHERE farm_id = '{{ farm_id }}' --required
AND fleet_id = '{{ fleet_id }}' --required
AND region = '{{ region }}' --required
AND `X-Amz-Client-Token` = '{{ X-Amz-Client-Token }}'
;

Lifecycle Methods

assume_fleet_role_for_read

Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

EXEC aws.deadline.fleets.assume_fleet_role_for_read 
@farm_id='{{ farm_id }}' --required, 
@fleet_id='{{ fleet_id }}' --required, 
@region='{{ region }}' --required
;