Class: Aws::ARCZonalShift::Types::StartZonalShiftRequest

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) 


1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1047

class StartZonalShiftRequest < Struct.new(
  :resource_identifier,
  :away_from,
  :expires_in,
  :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) 


1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1047

class StartZonalShiftRequest < Struct.new(
  :resource_identifier,
  :away_from,
  :expires_in,
  :comment)
  SENSITIVE = []
  include Aws::Structure
end

#expires_in ⇒ String

The length of time that you want a zonal shift to be active, which ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).

If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:

  • A lowercase letter m: To specify that the value is in minutes.

  • A lowercase letter h: To specify that the value is in hours.

For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1047

class StartZonalShiftRequest < Struct.new(
  :resource_identifier,
  :away_from,
  :expires_in,
  :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) 


1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'gems/aws-sdk-arczonalshift/lib/aws-sdk-arczonalshift/types.rb', line 1047

class StartZonalShiftRequest < Struct.new(
  :resource_identifier,
  :away_from,
  :expires_in,
  :comment)
  SENSITIVE = []
  include Aws::Structure
end