fleets

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

Overview

Name	fleets
Type	Resource
Description	AWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
Id	awscc.robomaker.fleets

Fields

get (all properties)

Name	Datatype	Description
arn	string
tags	object	A key-value pair to associate with a resource.
name	string	The name of the fleet.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	fleets	INSERT	, 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,
  arn,
  tags,
  name
FROM awscc.robomaker.fleets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all fleets in a region.

SELECT
  region,
  arn
FROM awscc.robomaker.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.robomaker.fleets (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.robomaker.fleets (
  Tags,
  Name,
  region
)
SELECT
  '{{ tags }}',
  '{{ name }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: fleet
    props:
      - name: tags
        value: {}
      - name: name
        value: '{{ name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.robomaker.fleets
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

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

Permissions

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

Create

robomaker:CreateFleet

Read

robomaker:DescribeFleet

Delete

robomaker:DeleteFleet

Update

robomaker:TagResource,
robomaker:UntagResource

List

robomaker:ListFleets