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

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Configuration, DisplayName, FarmId, MaxWorkerCount, RoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

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 data__Identifier = '<Arn>';

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 }}',
 '{{ DisplayName }}',
 '{{ FarmId }}',
 '{{ MaxWorkerCount }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.deadline.fleets (
 Configuration,
 Description,
 DisplayName,
 FarmId,
 HostConfiguration,
 MaxWorkerCount,
 MinWorkerCount,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ Configuration }}',
 '{{ Description }}',
 '{{ DisplayName }}',
 '{{ FarmId }}',
 '{{ HostConfiguration }}',
 '{{ MaxWorkerCount }}',
 '{{ MinWorkerCount }}',
 '{{ RoleArn }}',
 '{{ 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: DisplayName
        value: '{{ DisplayName }}'
      - name: FarmId
        value: '{{ FarmId }}'
      - name: HostConfiguration
        value:
          ScriptBody: '{{ ScriptBody }}'
          ScriptTimeoutSeconds: '{{ ScriptTimeoutSeconds }}'
      - name: MaxWorkerCount
        value: '{{ MaxWorkerCount }}'
      - name: MinWorkerCount
        value: '{{ MinWorkerCount }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.fleets
WHERE data__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