Class: Aws::ARCZonalShift::Types::ZonalShift

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

Overview

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) 


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1324

class ZonalShift < Struct.new(
  :zonal_shift_id,
  :resource_identifier,
  :away_from,
  :expiry_time,
  :start_time,
  :status,
  :comment)
  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. A new comment overwrites any existing comment string.

Returns:

  • (String) 


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1324

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


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1324

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

#resource_identifier ⇒ String

The identifier for the resource that Amazon Web Services shifts traffic for. 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) 


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1324

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

#start_time ⇒ Time

The time (UTC) when the zonal shift starts.

Returns:

  • (Time) 


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1324

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


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1324

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

#zonal_shift_id ⇒ String

The identifier of a zonal shift.

Returns:

  • (String) 


1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1324

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