Class: Aws::ARCRegionswitch::Types::GetPlanExecutionResponse

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

#actual_recovery_time ⇒ String

The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ String

A comment included on the plan execution.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The time (UTC) when the plan execution ended.

Returns:

  • (Time) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#execution_action ⇒ String

The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#execution_id ⇒ String

The execution identifier of a plan execution.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#execution_region ⇒ String

The Amazon Web Services Region for a plan execution.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#execution_state ⇒ String

The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#mode ⇒ String

The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#plan ⇒ Types::Plan

The details of the Region switch plan.

Returns:



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#plan_arn ⇒ String

The Amazon Resource Name (ARN) of the plan.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The time (UTC) when the plan execution started.

Returns:

  • (Time) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#step_states ⇒ Array<Types::StepState>

The states of the steps in the plan execution.

Returns:



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp when the plan execution was last updated.

Returns:

  • (Time) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version for the plan.

Returns:

  • (String) 


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 997

class GetPlanExecutionResponse < Struct.new(
  :plan_arn,
  :execution_id,
  :version,
  :updated_at,
  :comment,
  :start_time,
  :end_time,
  :mode,
  :execution_state,
  :execution_action,
  :execution_region,
  :step_states,
  :plan,
  :actual_recovery_time,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end