Class CfnSimulation
Use the AWS::SimSpaceWeaver::Simulation
resource to specify a simulation that AWS CloudFormation starts in the AWS Cloud , in your AWS account .
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SimSpaceWeaver
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSimulation : CfnResource, IInspectable
Syntax (vb)
Public Class CfnSimulation
Inherits CfnResource
Implements IInspectable
Remarks
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 .
Specify a SnapshotS3Location
to start a simulation from a snapshot instead of from a schema. When you start a simulation from a snapshot, SimSpace Weaver initializes the entity data in the State Fabric with data saved in the snapshot, starts the spatial and service apps that were running when the snapshot was created, and restores the clock to the appropriate tick. Your app zip files must be in the same location in Amazon S3 as they were in for the original simulation. You must start any custom apps separately. For more information about snapshots, see Snapshots in the AWS SimSpace Weaver User Guide .
CloudformationResource: AWS::SimSpaceWeaver::Simulation
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SimSpaceWeaver;
var cfnSimulation = new CfnSimulation(this, "MyCfnSimulation", new CfnSimulationProps {
Name = "name",
RoleArn = "roleArn",
// the properties below are optional
MaximumDuration = "maximumDuration",
SchemaS3Location = new S3LocationProperty {
BucketName = "bucketName",
ObjectKey = "objectKey"
},
SnapshotS3Location = new S3LocationProperty {
BucketName = "bucketName",
ObjectKey = "objectKey"
}
});
Synopsis
Constructors
CfnSimulation(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSimulation(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSimulation(Construct, String, ICfnSimulationProps) |
Properties
AttrDescribePayload | The JSON blob that the DescribeSimulation action returns. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
MaximumDuration | The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). |
Name | The name of the simulation. |
RoleArn | The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions. |
SchemaS3Location | The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ). |
SnapshotS3Location | The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ). |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSimulation(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSimulation(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSimulation(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSimulation(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSimulation(Construct, String, ICfnSimulationProps)
public CfnSimulation(Construct scope, string id, ICfnSimulationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSimulationProps
Resource properties.
Properties
AttrDescribePayload
The JSON blob that the DescribeSimulation action returns.
public virtual string AttrDescribePayload { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DescribePayload
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
MaximumDuration
The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D).
public virtual string MaximumDuration { get; set; }
Property Value
System.String
Name
The name of the simulation.
public virtual string Name { get; set; }
Property Value
System.String
RoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions.
public virtual string RoleArn { get; set; }
Property Value
System.String
SchemaS3Location
The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ).
public virtual object SchemaS3Location { get; set; }
Property Value
System.Object
SnapshotS3Location
The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ).
public virtual object SnapshotS3Location { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>