Class CfnSimulationProps

Properties for defining a CfnSimulation.

Inheritance

object

CfnSimulationProps

Implements

ICfnSimulationProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SimSpaceWeaver

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSimulationProps : ICfnSimulationProps

Syntax (vb)

Public Class CfnSimulationProps Implements ICfnSimulationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html

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

Constructors

CfnSimulationProps()

Properties for defining a CfnSimulation.

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 ).

Constructors

CfnSimulationProps()

Properties for defining a CfnSimulation.

public CfnSimulationProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html

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"
                 }
             };

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).

public string? MaximumDuration { get; set; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-maximumduration

Name

The name of the simulation.

public string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-name

RoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions.

public string RoleArn { get; set; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-rolearn

SchemaS3Location

The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ).

public object? SchemaS3Location { get; set; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-schemas3location

SnapshotS3Location

The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ).

public object? SnapshotS3Location { get; set; }

Property Value

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html#cfn-simspaceweaver-simulation-snapshots3location

Implements

ICfnSimulationProps