Class: Aws::SimSpaceWeaver::Types::StartSimulationInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_token]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 1019

class StartSimulationInput < Struct.new(
  :client_token,
  :description,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_s3_location,
  :snapshot_s3_location,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#description ⇒ String

The description of the simulation.

Returns:

  • (String) 


1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 1019

class StartSimulationInput < Struct.new(
  :client_token,
  :description,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_s3_location,
  :snapshot_s3_location,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#maximum_duration ⇒ String

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.

Returns:

  • (String) 


1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 1019

class StartSimulationInput < Struct.new(
  :client_token,
  :description,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_s3_location,
  :snapshot_s3_location,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#name ⇒ String

The name of the simulation.

Returns:

  • (String) 


1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 1019

class StartSimulationInput < Struct.new(
  :client_token,
  :description,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_s3_location,
  :snapshot_s3_location,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the 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 Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.

Returns:

  • (String) 


1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 1019

class StartSimulationInput < Struct.new(
  :client_token,
  :description,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_s3_location,
  :snapshot_s3_location,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#schema_s3_location ⇒ Types::S3Location

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:



1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 1019

class StartSimulationInput < Struct.new(
  :client_token,
  :description,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_s3_location,
  :snapshot_s3_location,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#snapshot_s3_location ⇒ Types::S3Location

The location of the snapshot .zip file 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.

The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

Returns:



1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 1019

class StartSimulationInput < Struct.new(
  :client_token,
  :description,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_s3_location,
  :snapshot_s3_location,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

Returns:

  • (Hash<String,String>) 


1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'gems/aws-sdk-simspaceweaver/lib/aws-sdk-simspaceweaver/types.rb', line 1019

class StartSimulationInput < Struct.new(
  :client_token,
  :description,
  :maximum_duration,
  :name,
  :role_arn,
  :schema_s3_location,
  :snapshot_s3_location,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end