AWS::RoboMaker::RobotApplication

The AWS::RoboMaker::RobotApplication resource creates an AWS RoboMaker robot application.

Syntax

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

JSON

{
  "Type" : "AWS::RoboMaker::RobotApplication",
  "Properties" : {
      "CurrentRevisionId" : String,
      "Environment" : String,
      "Name" : String,
      "RobotSoftwareSuite" : RobotSoftwareSuite,
      "Sources" : [ SourceConfig, ... ],
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::RoboMaker::RobotApplication
Properties:
  CurrentRevisionId: String
  Environment: String
  Name: String
  RobotSoftwareSuite: 
    RobotSoftwareSuite
  Sources: 
    - SourceConfig
  Tags: 
    Key: Value

Properties

CurrentRevisionId

The current revision id.

Required: No

Type: String

Minimum: 1

Maximum: 40

Update requires: No interruption

Environment

The environment of the robot application.

Required: No

Type: String

Update requires: No interruption

Name

The name of the robot application.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

RobotSoftwareSuite

The robot software suite used by the robot application.

Required: Yes

Type: RobotSoftwareSuite

Update requires: No interruption

Sources

The sources of the robot application.

Required: No

Type: Array of SourceConfig

Update requires: No interruption

Tags

A map that contains tag keys and tag values that are attached to the robot application.

Required: No

Type: Object of String

Pattern: ^[a-zA-Z0-9-]{1,128}$

Minimum: 1

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of an AWS::RoboMaker::RobotApplication resource to the intrinsic Ref function, the function returns the Amazon Resource Name (ARN) of the robot application, such as arn:aws:robomaker:us-west-2:123456789012:robot-application/MyRobotApplication/1546541208251.

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

Fn::GetAtt

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

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the robot application.

CurrentRevisionId

The current revision id.

Examples

Create an AWS RoboMaker Robot Application

The following example creates a robot application.

JSON

{
  "Description": "Robot Application example",
  "Resources": {
    "BasicRobotApplication": {
      "Type": "AWS::RoboMaker::RobotApplication",
      "Properties": {
        "Name": "MyRobotApplication",
        "Environment": "111122223333.dkr.ecr.us-west-2.amazonaws.com/my-robot-app:latest",
        "RobotSoftwareSuite": {
          "Name": "General"
        },
        "Tags": {
          "Name": "BasicRobotApplication",
          "Type": "CFN"
        }
      }
    }
  },
  "Outputs": {
    "RobotApplication": {
      "Value": "BasicRobotApplication"
    }
  }
}

YAML

---
Description: "Robot Application example"
Resources:
  BasicRobotApplication:
    Type: "AWS::RoboMaker::RobotApplication"
    Properties:
      Name: "MyRobotApplication"
      Environment: "111122223333.dkr.ecr.us-west-2.amazonaws.com/my-robot-app:latest"
      RobotSoftwareSuite:
        Name: "General"
      Tags:
        "Name" : "BasicRobotApplication"
        "Type" : "CFN"
Outputs:
  RobotApplication:
    Value: !Ref BasicRobotApplication