Class CfnSimulation.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSimulation>
- Enclosing class:
- CfnSimulation
CfnSimulation.-
Method Summary
Modifier and TypeMethodDescriptionbuild()static CfnSimulation.BuildermaximumDuration(String maximumDuration) 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 name of the simulation.The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions.schemaS3Location(IResolvable schemaS3Location) The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ).schemaS3Location(CfnSimulation.S3LocationProperty schemaS3Location) The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ).snapshotS3Location(IResolvable snapshotS3Location) The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ).snapshotS3Location(CfnSimulation.S3LocationProperty snapshotS3Location) The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ).
-
Method Details
-
create
- Parameters:
scope-- scope in which this resource is defined.
id-- scoped id of the resource.
- Returns:
- a new instance of
CfnSimulation.Builder.
-
name
The name of the simulation.- Parameters:
name- The name of the simulation. This parameter is required.- Returns:
this
-
roleArn
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 .
- Parameters:
roleArn- The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions. This parameter is required.- Returns:
this
-
maximumDuration
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 is14D. A value equivalent to0makes the simulation immediately transition toSTOPPINGas soon as it reachesSTARTED.- Parameters:
maximumDuration- 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). This parameter is required.- Returns:
this
-
schemaS3Location
@Stability(Stable) public CfnSimulation.Builder schemaS3Location(CfnSimulation.S3LocationProperty schemaS3Location) 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
SchemaS3Locationto start your simulation from a schema.If you provide a
SchemaS3Locationthen you can't provide aSnapshotS3Location.- Parameters:
schemaS3Location- The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ). This parameter is required.- Returns:
this
-
schemaS3Location
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
SchemaS3Locationto start your simulation from a schema.If you provide a
SchemaS3Locationthen you can't provide aSnapshotS3Location.- Parameters:
schemaS3Location- The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ). This parameter is required.- Returns:
this
-
snapshotS3Location
@Stability(Stable) public CfnSimulation.Builder snapshotS3Location(CfnSimulation.S3LocationProperty snapshotS3Location) 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
SnapshotS3Locationto start your simulation from a snapshot.If you provide a
SnapshotS3Locationthen you can't provide aSchemaS3Location.- Parameters:
snapshotS3Location- The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ). This parameter is required.- Returns:
this
-
snapshotS3Location
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
SnapshotS3Locationto start your simulation from a snapshot.If you provide a
SnapshotS3Locationthen you can't provide aSchemaS3Location.- Parameters:
snapshotS3Location- The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ). This parameter is required.- Returns:
this
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnSimulation>- Returns:
- a newly built instance of
CfnSimulation.
-