CfnSimulationProps

class aws_cdk.aws_simspaceweaver.CfnSimulationProps(*, name, role_arn, maximum_duration=None, schema_s3_location=None, snapshot_s3_location=None)

Bases: object

Properties for defining a CfnSimulation.

Parameters:

name (str) – The name of the simulation.
role_arn (str) – 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 .
maximum_duration (Optional[str]) – 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 .
schema_s3_location (Union[S3LocationProperty, Dict[str, Any], IResolvable, None]) – 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 .
snapshot_s3_location (Union[S3LocationProperty, Dict[str, Any], IResolvable, None]) –
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 .

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_simspaceweaver as simspaceweaver

cfn_simulation_props = simspaceweaver.CfnSimulationProps(
    name="name",
    role_arn="roleArn",

    # the properties below are optional
    maximum_duration="maximumDuration",
    schema_s3_location=simspaceweaver.CfnSimulation.S3LocationProperty(
        bucket_name="bucketName",
        object_key="objectKey"
    ),
    snapshot_s3_location=simspaceweaver.CfnSimulation.S3LocationProperty(
        bucket_name="bucketName",
        object_key="objectKey"
    )
)

Attributes

maximum_duration

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 .

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

name

The name of the simulation.

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

role_arn

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 .

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

schema_s3_location

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 .

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

snapshot_s3_location

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 .

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