Class: Aws::ARCRegionswitch::Types::CreatePlanRequest

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

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

The alarms associated with a Region switch plan.

Returns:



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of a Region switch plan.

Returns:

  • (String) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role ⇒ String

An execution role is a way to categorize a Region switch plan.

Returns:

  • (String) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of a Region switch plan.

Returns:

  • (String) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#primary_region ⇒ String

The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.

Returns:

  • (String) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  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) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_time_objective_minutes ⇒ Integer

Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.

Returns:

  • (Integer) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.

Returns:

  • (Array<String>) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#report_configuration ⇒ Types::ReportConfiguration

Configuration for automatic report generation for plan executions. When configured, Region switch automatically generates a report after each plan execution that includes execution events, plan configuration, and CloudWatch alarm states.

Returns:



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#service_quota_checks_enabled ⇒ Boolean

Specifies whether to enable service quota checks for the Region switch plan.

Returns:

  • (Boolean) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags to apply to the Region switch plan.

Returns:

  • (Hash<String,String>) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#triggers ⇒ Array<Types::Trigger>

The triggers associated with a Region switch plan.

Returns:



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#workflows ⇒ Array<Types::Workflow>

An array of workflows included in a Region switch plan.

Returns:



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/types.rb', line 524

class CreatePlanRequest < Struct.new(
  :description,
  :workflows,
  :execution_role,
  :recovery_time_objective_minutes,
  :associated_alarms,
  :triggers,
  :report_configuration,
  :service_quota_checks_enabled,
  :name,
  :regions,
  :recovery_approach,
  :primary_region,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end