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

Filter View: All JSON YAML

AWS::RoboMaker::SimulationApplication

The AWS::RoboMaker::SimulationApplication resource creates an AWS RoboMaker simulation application. For more information, see API_CreateSimulationApplication in the RoboMaker Developer Guide.

Syntax

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

JSON

{
  "Type" : "AWS::RoboMaker::SimulationApplication",
  "Properties" : {
    "CurrentRevisionId" : String,
    "Name" : String,
    "RenderingEngine" : RenderingEngine,
    "RobotSoftwareSuite" : RobotSoftwareSuite,
    "SimulationSoftwareSuite" : SimulationSoftwareSuite,
    "Sources" : [ SourceConfig, ... ],
    "Tags" : JSON object 
  }
}

YAML

Type: "AWS::RoboMaker::SimulationApplication"
Properties:
  CurrentRevisionId: String
  Name: String
  RenderingEngine: RenderingEngine
  RobotSoftwareSuite: RobotSoftwareSuite
  SimulationSoftwareSuite: SimulationSoftwareSuite
  Sources: 
    - SourceConfig
  Tags: JSON object

Properties

CurrentRevisionId

The current revision id.

Required: No

Type: String

Update requires: No interruption

Name

The name of the simulation application.

Required: No

Type: String

Update requires: Replacement

RenderingEngine

The rendering engine.

Required: Yes

Type: RenderingEngine

Update requires: Replacement

RobotSoftwareSuite

The robot software suite.

Required: Yes

Type: RobotSoftwareSuite

Update requires: Replacement

SimulationSoftwareSuite

The simulation software suite.

Required: Yes

Type: SimulationSoftwareSuite

Update requires: Replacement

Sources

The sources of the simulation application.

Required: Yes

Type: List of SourceConfig property types

Update requires: No interruption

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::SimulationApplication resource to the intrinsic Ref function, the function returns the Amazon Resource Name (ARN) of the simulation application, such as arn:aws:robomaker:us-west-2:123456789012:simulation-application/MySimulationApplication/1546541201334.

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 simulation application, such as arn:aws:robo-maker:us-east-1:123456789012:simulation-application/simulation-application-a1bzhi.

CurrentRevisionId

The current revision id, such as 2.

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

Examples

Create an AWS RoboMaker Simulation Application

The following example creates a simulation application.

JSON

{
  "Description": "RoboMaker SimulationApplication example",
  "Resources": {
    "BasicSimulationApplication": {
      "Type": "AWS::RoboMaker::SimulationApplication",
      "Properties": {
        "Name": "MySimulationApplication",
        "Sources": [
          {
            "S3Bucket": "my-bucket",
            "S3Key": "robot_bundle_x86.tar.gz",
            "Architecture": "X86_64"
          }
        ],
        "RobotSoftwareSuite": {
          "Name": "ROS",
          "Version": "Kinetic"
        },
        "SimulationSoftwareSuite": {
          "Name": "Gazebo",
          "Version": "7"
        },
        "RenderingEngine": {
          "Name": "OGRE",
          "Version": "1.x"
        },
        "Tags": {
          "Name": "BasicSimulationApplication",
          "Type": "CFN"
        }
      }
    }
  },
  "Outputs": {
    "SimulationApplication": {
      "Value": "BasicSimulationApplication"
    }
  }
}

YAML

---
Description: "RoboMaker SimulationApplication example"
Resources:
  BasicSimulationApplication:
    Type: "AWS::RoboMaker::SimulationApplication"
    Properties:
      Name: "MySimulationApplication"
      Sources:
        - S3Bucket: "my-bucket"
          S3Key: "robot_bundle_x86.tar.gz"
          Architecture: "X86_64"
      RobotSoftwareSuite:
        Name: "ROS"
        Version: "Kinetic"
      SimulationSoftwareSuite:
        Name: "Gazebo"
        Version: "7"
      RenderingEngine:
        Name: "OGRE"
        Version: "1.x"
      Tags:
        "Name" : "BasicSimulationApplication"
        "Type" : "CFN"
Outputs:
  SimulationApplication:
    Value: !Ref BasicSimulationApplication