1.204.0

interface CfnSimulationProps

LanguageType name
.NETAmazon.CDK.AWS.SimSpaceWeaver.CfnSimulationProps
Javasoftware.amazon.awscdk.services.simspaceweaver.CfnSimulationProps
Pythonaws_cdk.aws_simspaceweaver.CfnSimulationProps
TypeScript @aws-cdk/aws-simspaceweaver » CfnSimulationProps

Properties for defining a CfnSimulation.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as simspaceweaver from '@aws-cdk/aws-simspaceweaver';
const cfnSimulationProps: simspaceweaver.CfnSimulationProps = {
  name: 'name',
  roleArn: 'roleArn',

  // the properties below are optional
  maximumDuration: 'maximumDuration',
  schemaS3Location: {
    bucketName: 'bucketName',
    objectKey: 'objectKey',
  },
  snapshotS3Location: {
    bucketName: 'bucketName',
    objectKey: 'objectKey',
  },
};

Properties

NameTypeDescription
namestringThe name of the simulation.
roleArnstringThe Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions.
maximumDuration?stringThe maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D).
schemaS3Location?S3LocationProperty | IResolvableThe location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ).
snapshotS3Location?S3LocationProperty | IResolvableThe location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ).

name

Type: string

The name of the simulation.

roleArn

Type: string

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 .

maximumDuration?

Type: string (optional)

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

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 .

schemaS3Location?

Type: S3LocationProperty | IResolvable (optional)

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 .

Provide a SchemaS3Location to start your simulation from a schema.

If you provide a SchemaS3Location then you can't provide a SnapshotS3Location .

snapshotS3Location?

Type: S3LocationProperty | IResolvable (optional)

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

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 .

← PreviousNext →