Class: Aws::ARCZonalShift::Types::ZonalShiftSummary

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

Overview

Lists information about zonal shifts in Amazon Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that ARC starts on your behalf for practice runs with zonal autoshift.

Zonal shifts are temporary, including customer-initiated zonal shifts and the zonal autoshift practice run zonal shifts that ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#away_from ⇒ String

The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.

Returns:

  • (String) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ String

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.

Returns:

  • (String) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end

#expiry_time ⇒ Time

The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.

When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.

Returns:

  • (Time) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end

#practice_run_outcome ⇒ String

The outcome, or end state, of a practice run. The following values can be returned:

  • PENDING: Outcome value when the practice run is in progress.

  • SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

  • INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.

  • FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

  • CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.

For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

Returns:

  • (String) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifier ⇒ String

The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:

Returns:

  • (String) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end

#shift_type ⇒ String

Defines the zonal shift type.

Returns:

  • (String) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The time (UTC) when the zonal shift starts.

Returns:

  • (Time) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

  • ACTIVE: The zonal shift has been started and is active.

  • EXPIRED: The zonal shift has expired (the expiry time was exceeded).

  • CANCELED: The zonal shift was canceled.

Returns:

  • (String) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end

#zonal_shift_id ⇒ String

The identifier of a zonal shift.

Returns:

  • (String) 


1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1601

class ZonalShiftSummary < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment,
  :shift_type,
  :practice_run_outcome)
  SENSITIVE = []
  include Aws::Structure
end