Class: AWSCDK::SimSpaceWeaver::CfnSimulationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sim_space_weaver/cfn_simulation_props.rb

Overview

Properties for defining a CfnSimulation.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, role_arn:, maximum_duration: nil, schema_s3_location: nil, snapshot_s3_location: nil) ⇒ CfnSimulationProps

Returns a new instance of CfnSimulationProps.

Parameters:

  • name (String) —

    The name of the simulation.

  • role_arn (String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role that the simulation assumes to perform actions.

  • maximum_duration (String, nil) (defaults to: nil) —

    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).

  • schema_s3_location (AWSCDK::IResolvable, AWSCDK::SimSpaceWeaver::CfnSimulation::S3LocationProperty, nil) (defaults to: nil) —

    The location of the simulation schema in Amazon Simple Storage Service ( Amazon S3 ).

  • snapshot_s3_location (AWSCDK::IResolvable, AWSCDK::SimSpaceWeaver::CfnSimulation::S3LocationProperty, nil) (defaults to: nil) —

    The location of the snapshot in Amazon Simple Storage Service ( Amazon S3 ).



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'sim_space_weaver/cfn_simulation_props.rb', line 14

def initialize(name:, role_arn:, maximum_duration: nil, schema_s3_location: nil, snapshot_s3_location: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @maximum_duration = maximum_duration
  Jsii::Type.check_type(@maximum_duration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maximumDuration") unless @maximum_duration.nil?
  @schema_s3_location = schema_s3_location.is_a?(Hash) ? ::AWSCDK::SimSpaceWeaver::CfnSimulation::S3LocationProperty.new(**schema_s3_location.transform_keys(&:to_sym)) : schema_s3_location
  Jsii::Type.check_type(@schema_s3_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zaW1zcGFjZXdlYXZlci5DZm5TaW11bGF0aW9uLlMzTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "schemaS3Location") unless @schema_s3_location.nil?
  @snapshot_s3_location = snapshot_s3_location.is_a?(Hash) ? ::AWSCDK::SimSpaceWeaver::CfnSimulation::S3LocationProperty.new(**snapshot_s3_location.transform_keys(&:to_sym)) : snapshot_s3_location
  Jsii::Type.check_type(@snapshot_s3_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zaW1zcGFjZXdlYXZlci5DZm5TaW11bGF0aW9uLlMzTG9jYXRpb25Qcm9wZXJ0eSJ9XX19")), "snapshotS3Location") unless @snapshot_s3_location.nil?
end

Instance Attribute Details

#maximum_duration ⇒ String? (readonly)

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, nil)

See Also:



45
46
47
 
# File 'sim_space_weaver/cfn_simulation_props.rb', line 45

def maximum_duration
  @maximum_duration
end

#name ⇒ String (readonly)

The name of the simulation.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'sim_space_weaver/cfn_simulation_props.rb', line 31

def name
  @name
end

#role_arn ⇒ String (readonly)

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 .

Returns:

  • (String)

See Also:



38
39
40
 
# File 'sim_space_weaver/cfn_simulation_props.rb', line 38

def role_arn
  @role_arn
end

#schema_s3_location ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



56
57
58
 
# File 'sim_space_weaver/cfn_simulation_props.rb', line 56

def schema_s3_location
  @schema_s3_location
end

#snapshot_s3_location ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



67
68
69
 
# File 'sim_space_weaver/cfn_simulation_props.rb', line 67

def snapshot_s3_location
  @snapshot_s3_location
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
 
# File 'sim_space_weaver/cfn_simulation_props.rb', line 69

def self.jsii_properties
  {
    :name => "name",
    :role_arn => "roleArn",
    :maximum_duration => "maximumDuration",
    :schema_s3_location => "schemaS3Location",
    :snapshot_s3_location => "snapshotS3Location",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'sim_space_weaver/cfn_simulation_props.rb', line 79

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "roleArn" => @role_arn,
    "maximumDuration" => @maximum_duration,
    "schemaS3Location" => @schema_s3_location,
    "snapshotS3Location" => @snapshot_s3_location,
  })
  result.compact
end