AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon RoboMaker Resource Types Reference » AWS::RoboMaker::Fleet

Filter View: All JSON YAML

AWS::RoboMaker::Fleet

The AWS::RoboMaker::Fleet resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments. For more information, see API_CreateFleet in the RoboMaker Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::RoboMaker::Fleet",
  "Properties" : {
    "Name" : String,
    "Tags" : JSON object
  }
}

YAML

Type: "AWS::RoboMaker::Fleet"
Properties:
  Name: String
  Tags: JSON object

Properties

Name

The name of the fleet.

Required: No

Type: String

Update requires: Replacement

Tags

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Required: No

Type: JSON object

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of an AWS::RoboMaker::Fleet resource to the intrinsic Ref function, the function returns the Amazon Resource Name (ARN) of the fleet, such as arn:aws:robomaker:us-west-2:123456789012:deployment-fleet/MyFleet/1539894765711.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

Arn

The Amazon Resource Name (ARN) of the fleet, such as arn:aws:robomaker:us-west-2:123456789012:deployment-fleet/MyFleet/1539894765711.

For more information about using Fn::GetAtt, see Fn::GetAtt.

Examples

Create an AWS RoboMaker Fleet

The following example creates a fleet.

JSON

{
  "Description": "RoboMaker Fleet example",
  "Resources": {
    "BasicFleet": {
      "Type": "AWS::RoboMaker::Fleet",
      "Properties": {
        "Name": "MyFleet",
        "Tags": {
          "Name": "BasicFleet",
          "Type": "CFN"
        }
      }
    }
  },
  "Outputs": {
    "Fleet": {
      "Value": "BasicFleet"
    }
  }
}

YAML

---
Description: "RoboMaker Fleet example"
Resources:
  BasicFleet:
    Type: "AWS::RoboMaker::Fleet"
    Properties:
      Name: "MyFleet"
      Tags:
        "Name" : "BasicFleet"
        "Type" : "CFN"
Outputs:
  Fleet:
    Value: !Ref BasicFleet