AWS::RoboMaker::SimulationApplication - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::RoboMaker::SimulationApplication

The AWS::RoboMaker::SimulationApplication resource creates an Amazon RoboMaker simulation application.

Syntax

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

JSON

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

YAML

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

Properties

CurrentRevisionId

The current revision id.

Required: No

Type: String

Update requires: No interruption

Environment

The environment of the simulation application.

Required: No

Type: String

Update requires: No interruption

Name

The name of the simulation application.

Required: No

Type: String

Pattern: [a-zA-Z0-9_\-]*

Minimum: 1

Maximum: 255

Update requires: Replacement

RenderingEngine

The rendering engine for the simulation application.

Required: No

Type: RenderingEngine

Update requires: No interruption

RobotSoftwareSuite

The robot software suite used by the simulation application.

Required: Yes

Type: RobotSoftwareSuite

Update requires: No interruption

SimulationSoftwareSuite

The simulation software suite used by the simulation application.

Required: Yes

Type: SimulationSoftwareSuite

Update requires: No interruption

Sources

The sources of the simulation 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 simulation 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::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

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 simulation application.

CurrentRevisionId

The current revision id.

Examples

Create an Amazon RoboMaker Simulation Application

The following example creates a simulation application.

JSON

{
  "Description": "RoboMaker SimulationApplication example",
  "Resources": {
    "BasicSimulationApplication": {
      "Type": "AWS::RoboMaker::SimulationApplication",
      "Properties": {
        "Name": "MySimulationApplication",
        "Environment": "111122223333.dkr.ecr.us-west-2.amazonaws.com/my-sim-app:latest",
        "RobotSoftwareSuite": {
          "Name": "General"
        },
        "SimulationSoftwareSuite": {
          "Name": "SimulationRuntime"
        },
        "Tags": {
          "Name": "BasicSimulationApplication",
          "Type": "CFN"
        }
      }
    }
  },
  "Outputs": {
    "SimulationApplication": {
      "Value": "BasicSimulationApplication"
    }
  }
}

YAML

---
Description: "RoboMaker SimulationApplication example"
Resources:
  BasicSimulationApplication:
    Type: "AWS::RoboMaker::SimulationApplication"
    Properties:
      Name: "MySimulationApplication"
      Environment: "111122223333.dkr.ecr.us-west-2.amazonaws.com/my-sim-app:latest"
      RobotSoftwareSuite:
        Name: "General"
      SimulationSoftwareSuite:
        Name: "SimulationRuntime"
      Tags:
        "Name" : "BasicSimulationApplication"
        "Type" : "CFN"
Outputs:
  SimulationApplication:
    Value: !Ref BasicSimulationApplication