Package software.amazon.awscdk.services.simspaceweaver

Interface CfnSimulationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSimulationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:47.454Z")
@Stability(Stable)
public interface CfnSimulationProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.simspaceweaver.*;
 CfnSimulationProps cfnSimulationProps = CfnSimulationProps.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSimulationProps.Builder	A builder for CfnSimulationProps
static final class	CfnSimulationProps.Jsii$Proxy	An implementation for CfnSimulationProps

Method Summary

Modifier and Type	Method	Description
static CfnSimulationProps.Builder	builder()
default 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).
String	getName()	The name of the simulation.
String	getRoleArn()	The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions.
default Object	getSchemaS3Location()	The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ).
default Object	getSnapshotS3Location()	The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the simulation.

See Also:

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

getRoleArn

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

See Also:

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

getMaximumDuration

@Stability(Stable)
@Nullable
default 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 .

See Also:

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

getSchemaS3Location

@Stability(Stable)
@Nullable
default 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 .

Returns union: either IResolvable or CfnSimulation.S3LocationProperty

See Also:

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

getSnapshotS3Location

@Stability(Stable)
@Nullable
default 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 .

Returns union: either IResolvable or CfnSimulation.S3LocationProperty

See Also:

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

builder

@Stability(Stable)
static CfnSimulationProps.Builder builder()

Returns:

a CfnSimulationProps.Builder of CfnSimulationProps