Package software.amazon.awscdk.services.simspaceweaver

Class CfnSimulation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.simspaceweaver.CfnSimulation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.811Z") @Stability(Stable) public class CfnSimulation extends CfnResource implements IInspectable
A CloudFormation AWS::SimSpaceWeaver::Simulation.

Use the AWS::SimSpaceWeaver::Simulation resource to specify a simulation that AWS 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.services.simspaceweaver.*;
 CfnSimulation cfnSimulation = CfnSimulation.Builder.create(this, "MyCfnSimulation")
         .name("name")
         .roleArn("roleArn")
         // the properties below are optional
         .maximumDuration("maximumDuration")
         .schemaS3Location(S3LocationProperty.builder()
                 .bucketName("bucketName")
                 .objectKey("objectKey")
                 .build())
         .snapshotS3Location(S3LocationProperty.builder()
                 .bucketName("bucketName")
                 .objectKey("objectKey")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSimulation

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

    • CfnSimulation

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

    • CfnSimulation

      @Stability(Stable) public CfnSimulation(@NotNull Construct scope, @NotNull String id, @NotNull CfnSimulationProps props)
      Create a new AWS::SimSpaceWeaver::Simulation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDescribePayload

      @Stability(Stable) @NotNull public String getAttrDescribePayload()
      The JSON blob that the DescribeSimulation action returns.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the simulation.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the simulation.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      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 .

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      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 .

    • getMaximumDuration

      @Stability(Stable) @Nullable public String getMaximumDuration()
      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 .

    • setMaximumDuration

      @Stability(Stable) public void setMaximumDuration(@Nullable String value)
      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 .

    • getSchemaS3Location

      @Stability(Stable) @Nullable public Object getSchemaS3Location()
      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 .

    • setSchemaS3Location

      @Stability(Stable) public void setSchemaS3Location(@Nullable CfnSimulation.S3LocationProperty value)
      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 .

    • setSchemaS3Location

      @Stability(Stable) public void setSchemaS3Location(@Nullable IResolvable value)
      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 .

    • getSnapshotS3Location

      @Stability(Stable) @Nullable public Object getSnapshotS3Location()
      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 .

    • setSnapshotS3Location

      @Stability(Stable) public void setSnapshotS3Location(@Nullable CfnSimulation.S3LocationProperty value)
      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 .

    • setSnapshotS3Location

      @Stability(Stable) public void setSnapshotS3Location(@Nullable IResolvable value)
      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 .