CfnSimulationPropsMixin

class aws_cdk.mixins_preview.aws_simspaceweaver.mixins.CfnSimulationPropsMixin(props, *, strategy=None)

Bases: Mixin

Use the AWS::SimSpaceWeaver::Simulation resource to specify a simulation that CloudFormation starts in the AWS Cloud , in your AWS account .

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-simspaceweaver-simulation.html
CloudformationResource:: AWS::SimSpaceWeaver::Simulation
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_simulation_props_mixin = simspaceweaver_mixins.CfnSimulationPropsMixin(simspaceweaver_mixins.CfnSimulationMixinProps(
    maximum_duration="maximumDuration",
    name="name",
    role_arn="roleArn",
    schema_s3_location=simspaceweaver_mixins.CfnSimulationPropsMixin.S3LocationProperty(
        bucket_name="bucketName",
        object_key="objectKey"
    ),
    snapshot_s3_location=simspaceweaver_mixins.CfnSimulationPropsMixin.S3LocationProperty(
        bucket_name="bucketName",
        object_key="objectKey"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SimSpaceWeaver::Simulation.

Parameters:

props (Union[CfnSimulationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['maximumDuration', 'name', 'roleArn', 'schemaS3Location', 'snapshotS3Location']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

S3LocationProperty

class CfnSimulationPropsMixin.S3LocationProperty(*, bucket_name=None, object_key=None)

Bases: object

A location in Amazon Simple Storage Service ( Amazon S3 ) where SimSpace Weaver stores simulation data, such as your app .zip files and schema file. For more information about Amazon S3 , see the *Amazon Simple Storage Service User Guide* .

Parameters:

bucket_name (Optional[str]) – The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide .
object_key (Optional[str]) – The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see Uploading, downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

s3_location_property = simspaceweaver_mixins.CfnSimulationPropsMixin.S3LocationProperty(
    bucket_name="bucketName",
    object_key="objectKey"
)

Attributes

bucket_name

The name of an Amazon S3 bucket.

For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simspaceweaver-simulation-s3location.html#cfn-simspaceweaver-simulation-s3location-bucketname

object_key

The key name of an object in Amazon S3.

For more information about Amazon S3 objects and object keys, see Uploading, downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simspaceweaver-simulation-s3location.html#cfn-simspaceweaver-simulation-s3location-objectkey