queue_fleet_associations

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

Overview

Name	queue_fleet_associations
Type	Resource
Id	aws.deadline.queue_fleet_associations

Fields

The following fields are returned by SELECT queries:

get_queue_fleet_association

Name	Datatype	Description
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
fleet_id	string	The fleet ID for the queue-fleet association. (pattern: <code>fleet-[0-9a-f]{32}</code>)
queue_id	string	The queue ID for the queue-fleet association. (pattern: <code>queue-[0-9a-f]{32}</code>)
status	string	The status of the queue-fleet association. (ACTIVE, STOP_SCHEDULING_AND_COMPLETE_TASKS, STOP_SCHEDULING_AND_CANCEL_TASKS, STOPPED)
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

list_queue_fleet_associations

Name	Datatype	Description
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
fleet_id	string	The fleet ID. (pattern: <code>fleet-[0-9a-f]{32}</code>)
queue_id	string	The queue ID. (pattern: <code>queue-[0-9a-f]{32}</code>)
status	string	The status of task scheduling in the queue-fleet association. ACTIVE–Association is active. STOP_SCHEDULING_AND_COMPLETE_TASKS–Association has stopped scheduling new tasks and is completing current tasks. STOP_SCHEDULING_AND_CANCEL_TASKS–Association has stopped scheduling new tasks and is canceling current tasks. STOPPED–Association has been stopped. (ACTIVE, STOP_SCHEDULING_AND_COMPLETE_TASKS, STOP_SCHEDULING_AND_CANCEL_TASKS, STOPPED)
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_queue_fleet_association	select	farm_id, queue_id, fleet_id, region		Gets a queue-fleet association.
list_queue_fleet_associations	select	farm_id, region	nextToken, maxResults, queueId, fleetId	Lists queue-fleet associations.
create_queue_fleet_association	insert	farm_id, region, queueId, fleetId		Creates an association between a queue and a fleet.
update_queue_fleet_association	update	farm_id, queue_id, fleet_id, region, status		Updates a queue-fleet association.
delete_queue_fleet_association	delete	farm_id, queue_id, fleet_id, region		Deletes a queue-fleet association.

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 of the farm that holds the queue-fleet association.
fleet_id	string	The fleet ID of the queue-fleet association.
queue_id	string	The queue ID of the queue-fleet association.
region	string	AWS region (default: us-east-1)
fleetId	string	The fleet ID for the queue-fleet association list.
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.
queueId	string	The queue ID for the queue-fleet association list.

SELECT examples

get_queue_fleet_association

Gets a queue-fleet association.

SELECT
created_at,
created_by,
fleet_id,
queue_id,
status,
updated_at,
updated_by
FROM aws.deadline.queue_fleet_associations
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND fleet_id = '{{ fleet_id }}' -- required
AND region = '{{ region }}' -- required
;

list_queue_fleet_associations

Lists queue-fleet associations.

SELECT
created_at,
created_by,
fleet_id,
queue_id,
status,
updated_at,
updated_by
FROM aws.deadline.queue_fleet_associations
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND queueId = '{{ queueId }}'
AND fleetId = '{{ fleetId }}'
;

INSERT examples

create_queue_fleet_association

Creates an association between a queue and a fleet.

INSERT INTO aws.deadline.queue_fleet_associations (
queueId,
fleetId,
farm_id,
region
)
SELECT 
'{{ queueId }}' /* required */,
'{{ fleetId }}' /* required */,
'{{ farm_id }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: queue_fleet_associations
props:
  - name: farm_id
    value: "{{ farm_id }}"
    description: Required parameter for the queue_fleet_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the queue_fleet_associations resource.
  - name: queueId
    value: "{{ queueId }}"
  - name: fleetId
    value: "{{ fleetId }}"

UPDATE examples

update_queue_fleet_association

Updates a queue-fleet association.

UPDATE aws.deadline.queue_fleet_associations
SET 
status = '{{ status }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND fleet_id = '{{ fleet_id }}' --required
AND region = '{{ region }}' --required
AND status = '{{ status }}' --required;

DELETE examples

delete_queue_fleet_association

Deletes a queue-fleet association.

DELETE FROM aws.deadline.queue_fleet_associations
WHERE farm_id = '{{ farm_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND fleet_id = '{{ fleet_id }}' --required
AND region = '{{ region }}' --required
;