Class: Aws::ARCRegionswitch::Types::StartPlanExecutionRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The action to perform. Valid values are activate (to shift traffic to the target Region) or deactivate (to shift traffic away from the target Region).

Returns:

  • (String) 


2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2267

class StartPlanExecutionRequest < Struct.new(
  :plan_arn,
  :target_region,
  :action,
  :mode,
  :comment,
  :latest_version,
  :recovery_execution_id)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ String

An optional comment explaining why the plan execution is being started.

Returns:

  • (String) 


2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2267

class StartPlanExecutionRequest < Struct.new(
  :plan_arn,
  :target_region,
  :action,
  :mode,
  :comment,
  :latest_version,
  :recovery_execution_id)
  SENSITIVE = []
  include Aws::Structure
end

#latest_version ⇒ String

A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

Returns:

  • (String) 


2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2267

class StartPlanExecutionRequest < Struct.new(
  :plan_arn,
  :target_region,
  :action,
  :mode,
  :comment,
  :latest_version,
  :recovery_execution_id)
  SENSITIVE = []
  include Aws::Structure
end

#mode ⇒ String

The plan execution mode. Valid values are graceful, for starting the execution in graceful mode, or ungraceful, for starting the execution in ungraceful mode.

Returns:

  • (String) 


2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2267

class StartPlanExecutionRequest < Struct.new(
  :plan_arn,
  :target_region,
  :action,
  :mode,
  :comment,
  :latest_version,
  :recovery_execution_id)
  SENSITIVE = []
  include Aws::Structure
end

#plan_arn ⇒ String

The Amazon Resource Name (ARN) of the plan to execute.

Returns:

  • (String) 


2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2267

class StartPlanExecutionRequest < Struct.new(
  :plan_arn,
  :target_region,
  :action,
  :mode,
  :comment,
  :latest_version,
  :recovery_execution_id)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_execution_id ⇒ String

The execution identifier of the recovery execution that ran in the opposite region post-recovery is ran in. Required when starting a post-recovery execution.

Returns:

  • (String) 


2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2267

class StartPlanExecutionRequest < Struct.new(
  :plan_arn,
  :target_region,
  :action,
  :mode,
  :comment,
  :latest_version,
  :recovery_execution_id)
  SENSITIVE = []
  include Aws::Structure
end

#target_region ⇒ String

The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.

Returns:

  • (String) 


2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 2267

class StartPlanExecutionRequest < Struct.new(
  :plan_arn,
  :target_region,
  :action,
  :mode,
  :comment,
  :latest_version,
  :recovery_execution_id)
  SENSITIVE = []
  include Aws::Structure
end