fleets

Creates, updates, deletes or gets a fleet resource or lists fleets in a region

Overview

Name	fleets
Type	Resource
Description	Definition of AWS::Deadline::Fleet Resource Type
Id	awscc.deadline.fleets

Fields

get (all properties)

Name	Datatype	Description
▶capabilities	object
configuration	object
description	string
display_name	string
farm_id	string
fleet_id	string
▶host_configuration	object
max_worker_count	integer
min_worker_count	integer
role_arn	string
status	string
status_message	string
worker_count	integer
arn	string
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::Deadline::Fleet.

Methods

Name	Resource	Accessible by	Required Params
create_resource	fleets	INSERT	Configuration, DisplayName, FarmId, MaxWorkerCount, RoleArn, region
delete_resource	fleets	DELETE	Identifier, region
update_resource	fleets	UPDATE	Identifier, PatchDocument, region
list_resources	fleets_list_only	SELECT	region
get_resource	fleets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual fleet.

SELECT
  region,
  capabilities,
  configuration,
  description,
  display_name,
  farm_id,
  fleet_id,
  host_configuration,
  max_worker_count,
  min_worker_count,
  role_arn,
  status,
  status_message,
  worker_count,
  arn,
  tags
FROM awscc.deadline.fleets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all fleets in a region.

SELECT
  region,
  arn
FROM awscc.deadline.fleets_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new fleet resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.deadline.fleets (
  Configuration,
  DisplayName,
  FarmId,
  MaxWorkerCount,
  RoleArn,
  region
)
SELECT
  '{{ configuration }}',
  '{{ display_name }}',
  '{{ farm_id }}',
  '{{ max_worker_count }}',
  '{{ role_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.deadline.fleets (
  Configuration,
  Description,
  DisplayName,
  FarmId,
  HostConfiguration,
  MaxWorkerCount,
  MinWorkerCount,
  RoleArn,
  Tags,
  region
)
SELECT
  '{{ configuration }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ farm_id }}',
  '{{ host_configuration }}',
  '{{ max_worker_count }}',
  '{{ min_worker_count }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: fleet
    props:
      - name: configuration
        value: null
      - name: description
        value: '{{ description }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: farm_id
        value: '{{ farm_id }}'
      - name: host_configuration
        value:
          script_body: '{{ script_body }}'
          script_timeout_seconds: '{{ script_timeout_seconds }}'
      - name: max_worker_count
        value: '{{ max_worker_count }}'
      - name: min_worker_count
        value: '{{ min_worker_count }}'
      - name: role_arn
        value: '{{ role_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a fleet resource, using stack-deploy.

/*+ update */
UPDATE awscc.deadline.fleets
SET PatchDocument = string('{{ {
    "Configuration": configuration,
    "Description": description,
    "DisplayName": display_name,
    "HostConfiguration": host_configuration,
    "MaxWorkerCount": max_worker_count,
    "MinWorkerCount": min_worker_count,
    "RoleArn": role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.fleets
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the fleets resource, the following permissions are required:

Create

deadline:CreateFleet,
deadline:GetFleet,
iam:PassRole,
identitystore:ListGroupMembershipsForMember,
logs:CreateLogGroup,
deadline:TagResource,
deadline:ListTagsForResource,
vpc-lattice:GetResourceGateway,
vpc-lattice:GetResourceConfiguration,
ec2:CreateVpcEndpoint,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups,
ec2:DescribeVpcs

Read

deadline:GetFleet,
identitystore:ListGroupMembershipsForMember,
deadline:ListTagsForResource

Update

deadline:UpdateFleet,
deadline:GetFleet,
iam:PassRole,
identitystore:ListGroupMembershipsForMember,
deadline:TagResource,
deadline:UntagResource,
deadline:ListTagsForResource,
vpc-lattice:GetResourceGateway,
vpc-lattice:GetResourceConfiguration,
ec2:CreateVpcEndpoint,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups,
ec2:DescribeVpcs

Delete

deadline:DeleteFleet,
deadline:GetFleet,
identitystore:ListGroupMembershipsForMember

List

deadline:ListFleets,
identitystore:DescribeGroup,
identitystore:DescribeUser,
identitystore:ListGroupMembershipsForMember