Interface ICfnSimulationProps
Properties for defining a CfnSimulation
.
Namespace: Amazon.CDK.AWS.SimSpaceWeaver
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnSimulationProps
Syntax (vb)
Public Interface ICfnSimulationProps
Remarks
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 cfnSimulationProps = 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
Properties
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 ). |
Properties
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).
virtual string MaximumDuration { get; }
Property Value
System.String
Remarks
The simulation stops when it reaches this limit. The maximum value is 14D
, or its equivalent in the other units. The default value is 14D
. A value equivalent to 0
makes the simulation immediately transition to STOPPING
as soon as it reaches STARTED
.
Name
The name of the simulation.
string Name { get; }
Property Value
System.String
Remarks
RoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions.
string RoleArn { get; }
Property Value
System.String
Remarks
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 .
SchemaS3Location
The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ).
virtual object SchemaS3Location { get; }
Property Value
System.Object
Remarks
For more information about Amazon S3 , see the Amazon Simple Storage Service User Guide .
Provide a SchemaS3Location
to start your simulation from a schema.
If you provide a SchemaS3Location
then you can't provide a SnapshotS3Location
.
SnapshotS3Location
The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ).
virtual object SnapshotS3Location { get; }
Property Value
System.Object
Remarks
For more information about Amazon S3 , see the Amazon Simple Storage Service User Guide .
Provide a SnapshotS3Location
to start your simulation from a snapshot.
If you provide a SnapshotS3Location
then you can't provide a SchemaS3Location
.