Package software.amazon.awscdk.cfnpropertymixins.services.simspaceweaver

Class CfnSimulationPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.simspaceweaver.CfnSimulationPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.611Z") @Stability(Stable) public class CfnSimulationPropsMixin extends Mixin implements software.constructs.IMixin
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.simspaceweaver.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnSimulationPropsMixin cfnSimulationPropsMixin = CfnSimulationPropsMixin.Builder.create(CfnSimulationMixinProps.builder()
         .maximumDuration("maximumDuration")
         .name("name")
         .roleArn("roleArn")
         .schemaS3Location(S3LocationProperty.builder()
                 .bucketName("bucketName")
                 .objectKey("objectKey")
                 .build())
         .snapshotS3Location(S3LocationProperty.builder()
                 .bucketName("bucketName")
                 .objectKey("objectKey")
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnSimulationPropsMixin.Builder
    A fluent builder for CfnSimulationPropsMixin.
    static interface 
    CfnSimulationPropsMixin.S3LocationProperty
    A location in Amazon Simple Storage Service ( Amazon S3 ) where SimSpace Weaver stores simulation data, such as your app .zip files and schema file.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IMixin

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnSimulationPropsMixin(CfnSimulationMixinProps props)
    Create a mixin to apply properties to AWS::SimSpaceWeaver::Simulation.
     
    CfnSimulationPropsMixin(CfnSimulationMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::SimSpaceWeaver::Simulation.
    protected
    CfnSimulationPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnSimulationPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnSimulationMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnSimulationPropsMixin

      protected CfnSimulationPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSimulationPropsMixin

      protected CfnSimulationPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSimulationPropsMixin

      @Stability(Stable) public CfnSimulationPropsMixin(@NotNull CfnSimulationMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::SimSpaceWeaver::Simulation.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnSimulationPropsMixin

      @Stability(Stable) public CfnSimulationPropsMixin(@NotNull CfnSimulationMixinProps props)
      Create a mixin to apply properties to AWS::SimSpaceWeaver::Simulation.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnSimulationMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()