Class: Aws::ARCRegionswitch::Types::Plan

Inherits:

Struct

• Object
• Struct
• Aws::ARCRegionswitch::Types::Plan

Defined in:

gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb

Overview

Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the plan.

• #associated_alarms ⇒ Hash<String,Types::AssociatedAlarm>

  The associated application health alarms for a plan.

• #description ⇒ String

  The description for a plan.

• #execution_role ⇒ String

  The execution role for a plan.

• #name ⇒ String

  The name for a plan.

• #owner ⇒ String

  The owner of a plan.

• #primary_region ⇒ String

  The primary Region for a plan.

• #recovery_approach ⇒ String

  The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

• #recovery_time_objective_minutes ⇒ Integer

  The recovery time objective for a plan.

• #regions ⇒ Array<String>

  The Amazon Web Services Regions for a plan.

• #report_configuration ⇒ Types::ReportConfiguration

  The report configuration for a plan.

• #triggers ⇒ Array<Types::Trigger>

  The triggers for a plan.

• #updated_at ⇒ Time

  The timestamp when the plan was last updated.

• #version ⇒ String

  The version for the plan.

• #workflows ⇒ Array<Types::Workflow>

  The workflows for a plan.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the plan.

Returns:

• (String)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#associated_alarms ⇒ Hash<String,Types::AssociatedAlarm>

The associated application health alarms for a plan.

Returns:

• (Hash<String,Types::AssociatedAlarm>)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for a plan.

Returns:

• (String)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role ⇒ String

The execution role for a plan.

Returns:

• (String)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for a plan.

Returns:

• (String)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

The owner of a plan.

Returns:

• (String)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#primary_region ⇒ String

The primary Region for a plan.

Returns:

• (String)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_approach ⇒ String

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

Returns:

• (String)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_time_objective_minutes ⇒ Integer

The recovery time objective for a plan.

Returns:

• (Integer)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

The Amazon Web Services Regions for a plan.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#report_configuration ⇒ Types::ReportConfiguration

The report configuration for a plan.

Returns:

• (Types::ReportConfiguration)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#triggers ⇒ Array<Types::Trigger>

The triggers for a plan.

Returns:

• (Array<Types::Trigger>)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp when the plan was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version for the plan.

Returns:

• (String)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#workflows ⇒ Array<Types::Workflow>

The workflows for a plan.

Returns:

• (Array<Types::Workflow>)

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 1811

class Plan < Struct.new(
  :arn,
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :owner,
  :version,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end