/AWS1/CL_AZSZONALSHIFT¶
ZonalShift
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_ZONALSHIFTID TYPE /AWS1/AZSZONALSHIFTID /AWS1/AZSZONALSHIFTID¶
The identifier of a zonal shift.
IV_RESOURCEIDENTIFIER TYPE /AWS1/AZSRESOURCEIDENTIFIER /AWS1/AZSRESOURCEIDENTIFIER¶
The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
IV_AWAYFROM TYPE /AWS1/AZSAVAILABILITYZONE /AWS1/AZSAVAILABILITYZONE¶
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.
IV_EXPIRYTIME TYPE /AWS1/AZSEXPIRYTIME /AWS1/AZSEXPIRYTIME¶
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 Route 53 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.
IV_STARTTIME TYPE /AWS1/AZSSTARTTIME /AWS1/AZSSTARTTIME¶
The time (UTC) when the zonal shift starts.
IV_STATUS TYPE /AWS1/AZSZONALSHIFTSTATUS /AWS1/AZSZONALSHIFTSTATUS¶
A status for a zonal shift.
The
Statusfor a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
IV_COMMENT TYPE /AWS1/AZSZONALSHIFTCOMMENT /AWS1/AZSZONALSHIFTCOMMENT¶
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.
Queryable Attributes¶
zonalShiftId¶
The identifier of a zonal shift.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ZONALSHIFTID() |
Getter for ZONALSHIFTID, with configurable default |
ASK_ZONALSHIFTID() |
Getter for ZONALSHIFTID w/ exceptions if field has no value |
HAS_ZONALSHIFTID() |
Determine if ZONALSHIFTID has a value |
resourceIdentifier¶
The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEIDENTIFIER() |
Getter for RESOURCEIDENTIFIER, with configurable default |
ASK_RESOURCEIDENTIFIER() |
Getter for RESOURCEIDENTIFIER w/ exceptions if field has no |
HAS_RESOURCEIDENTIFIER() |
Determine if RESOURCEIDENTIFIER has a value |
awayFrom¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AWAYFROM() |
Getter for AWAYFROM, with configurable default |
ASK_AWAYFROM() |
Getter for AWAYFROM w/ exceptions if field has no value |
HAS_AWAYFROM() |
Determine if AWAYFROM has a value |
expiryTime¶
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 Route 53 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPIRYTIME() |
Getter for EXPIRYTIME, with configurable default |
ASK_EXPIRYTIME() |
Getter for EXPIRYTIME w/ exceptions if field has no value |
HAS_EXPIRYTIME() |
Determine if EXPIRYTIME has a value |
startTime¶
The time (UTC) when the zonal shift starts.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTTIME() |
Getter for STARTTIME, with configurable default |
ASK_STARTTIME() |
Getter for STARTTIME w/ exceptions if field has no value |
HAS_STARTTIME() |
Determine if STARTTIME has a value |
status¶
A status for a zonal shift.
The
Statusfor a zonal shift can have one of the following values:
ACTIVE: The zonal shift has been started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
comment¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMMENT() |
Getter for COMMENT, with configurable default |
ASK_COMMENT() |
Getter for COMMENT w/ exceptions if field has no value |
HAS_COMMENT() |
Determine if COMMENT has a value |