Class: Aws::ARCZonalShift::Types::ZonalShiftInResource

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

Overview

A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#applied_status ⇒ String

The ‘appliedStatus` field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The `appliedStatus` field for a shift that is in progress for a resource can have one of two values: `APPLIED` or `NOT_APPLIED`. The zonal shift or autoshift that is currently in effect for the resource has an `appliedStatus` set to `APPLIED`.

The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.

For more information, see [How zonal autoshift and practice runs work] in the Amazon Application Recovery Controller Developer Guide.

[1]: docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html

Returns:

  • (String) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

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

#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) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

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

#comment ⇒ String

A comment that you enter for a customer-initiated 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) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

class ZonalShiftInResource < Struct.new(
  :applied_status,
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :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) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

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

#practice_run_outcome ⇒ String

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

  • PENDING: Outcome value when a 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 the expected 30 minute zonal shift.

  • INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, 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.

[1]: docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.configure.html

Returns:

  • (String) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

class ZonalShiftInResource < Struct.new(
  :applied_status,
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :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:

  • Amazon EC2 Auto Scaling groups][1
  • Amazon Elastic Kubernetes Service][2
  • Application Load Balancer][3
  • Network Load Balancer][4

[1]: docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html [2]: docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html [3]: docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html [4]: docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html

Returns:

  • (String) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

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

#shift_type ⇒ String

Defines the zonal shift type.

Returns:

  • (String) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

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

#start_time ⇒ Time

The time (UTC) when the zonal shift starts.

Returns:

  • (Time) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

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

#zonal_shift_id ⇒ String

The identifier of a zonal shift.

Returns:

  • (String) 


1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/aws-sdk-arczonalshift/types.rb', line 1523

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