AWS::SimSpaceWeaver::Simulation
Use the AWS::SimSpaceWeaver::Simulation
resource to specify
a simulation that AWS CloudFormation starts in the AWS Cloud, in
your AWS account. In the resource properties section of your template,
provide the name of an existing IAM role
configured with the proper permissions, and the name of an existing Amazon S3 bucket.
Your account must have permissions to read the Amazon S3 bucket.
The Amazon S3 bucket must contain a valid schema. The schema must refer to
simulation assets that are already uploaded to the AWS Cloud. For more information,
see the
detailed tutorial in the AWS SimSpace Weaver User Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::SimSpaceWeaver::Simulation", "Properties" : { "Name" :
String
, "RoleArn" :String
, "SchemaS3Location" :S3Location
} }
YAML
Type: AWS::SimSpaceWeaver::Simulation Properties: Name:
String
RoleArn:String
SchemaS3Location:S3Location
Properties
Name
-
The name of the simulation.
Required: No
Type: String
Update requires: Replacement
RoleArn
-
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference. For more information about IAM roles, see IAM roles in the AWS Identity and Access Management User Guide.
Required: No
Type: String
Update requires: No interruption
SchemaS3Location
-
The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide.
Required: No
Type: S3Location
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the name of the Simulation
. For example,
MyTestSimulation_22-12-15_12_00_00
.
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.
DescribePayload
-
The JSON blob that the DescribeSimulation action returns.
Examples
Start a simulation
The following example specifies a simulation resource in the AWS Cloud.
JSON
{ "Description" : "SimSpace Weaver Simulation example 1", "Resources" : { "MyTestSimulation" : { "Type" : "AWS::SimSpaceWeaver::Simulation", "Properties" : { "Name" : "MyTestSimulation", "RoleArn" : "arn:aws:iam::111122223333:role/my-test-simulation-app-role", "SchemaS3Location" : { "BucketName" : "MyTestSimulationBucket", "ObjectKey" : "MyTestSimulation-schema.yaml" } } } } }
YAML
Description: "SimSpace Weaver Simulation example 1" Resources: MyTestSimulation: Type: "AWS::SimSpaceWeaver::Simulation" Properties: Name: "MyTestSimulation" RoleArn: "arn:aws:iam::111122223333:role/my-test-simulation-app-role" SchemaS3Location: BucketName: "MyTestSimulationBucket" ObjectKey: "MyTestSimulation-schema.yaml"
Start a simulation with assets that you created with the app SDK scripts
The following example specifies a simulation resource in the AWS Cloud
with assets that you created with the app SDK scripts. In this example,
the create-project
script used --name MyTestSimulation
and
uploaded to us-west-2
.
For more information, see the detailed tutorial
in the AWS SimSpace Weaver User Guide.
JSON
{ "Description" : "SimSpace Weaver Simulation example 2", "Resources" : { "MyTestSimulation" : { "Type" : "AWS::SimSpaceWeaver::Simulation", "Properties" : { "Name" : "MyTestSimulation_22-12-15_12_00_00", "RoleArn" : "arn:aws:iam::111122223333:role/weaver-MyTestSimulation-app-role", "SchemaS3Location" : { "BucketName" : "weaver-mytestsimulation-111122223333-schemas-us-west-2", "ObjectKey" : "MyTestSimulation-schema.yaml" } } } } }
YAML
Description: "SimSpace Weaver Simulation example 2" Resources: MyTestSimulation: Type: "AWS::SimSpaceWeaver::Simulation" Properties: Name: "MyTestSimulation_22-12-15_12_00_00" RoleArn: "arn:aws:iam::111122223333:role/weaver-MyTestSimulation-app-role" SchemaS3Location: BucketName: "weaver-mytestsimulation-111122223333-schemas-us-west-2" ObjectKey: "MyTestSimulation-schema.yaml"