@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ZonalShiftSummary extends Object implements Serializable, Cloneable, StructuredPojo
You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region. A zonal shift helps your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources in your account in an AWS Region. Supported AWS resources are automatically registered with Route 53 ARC.
Zonal shifts are temporary. A zonal shift can be active for up to three days (72 hours).
When you start a zonal shift, you specify how long you want it to be active, which Amazon Route 53 Application Recovery Controller converts to an expiry time (expiration time). You can cancel a zonal shift, for example, if you're ready to restore traffic to the Availability Zone. Or you can extend the zonal shift by updating the expiration so the zonal shift is active longer.
Constructor and Description |
---|
ZonalShiftSummary() |
Modifier and Type | Method and Description |
---|---|
ZonalShiftSummary |
clone() |
boolean |
equals(Object obj) |
String |
getAwayFrom()
The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
|
String |
getComment()
A comment that you enter about the zonal shift.
|
Date |
getExpiryTime()
The expiry time (expiration time) for the zonal shift.
|
String |
getResourceIdentifier()
The identifier for the resource to include in a zonal shift.
|
Date |
getStartTime()
The time (UTC) when the zonal shift is started.
|
String |
getStatus()
A status for a zonal shift.
|
String |
getZonalShiftId()
The identifier of a zonal shift.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAwayFrom(String awayFrom)
The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
|
void |
setComment(String comment)
A comment that you enter about the zonal shift.
|
void |
setExpiryTime(Date expiryTime)
The expiry time (expiration time) for the zonal shift.
|
void |
setResourceIdentifier(String resourceIdentifier)
The identifier for the resource to include in a zonal shift.
|
void |
setStartTime(Date startTime)
The time (UTC) when the zonal shift is started.
|
void |
setStatus(String status)
A status for a zonal shift.
|
void |
setZonalShiftId(String zonalShiftId)
The identifier of a zonal shift.
|
String |
toString()
Returns a string representation of this object.
|
ZonalShiftSummary |
withAwayFrom(String awayFrom)
The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
|
ZonalShiftSummary |
withComment(String comment)
A comment that you enter about the zonal shift.
|
ZonalShiftSummary |
withExpiryTime(Date expiryTime)
The expiry time (expiration time) for the zonal shift.
|
ZonalShiftSummary |
withResourceIdentifier(String resourceIdentifier)
The identifier for the resource to include in a zonal shift.
|
ZonalShiftSummary |
withStartTime(Date startTime)
The time (UTC) when the zonal shift is started.
|
ZonalShiftSummary |
withStatus(String status)
A status for a zonal shift.
|
ZonalShiftSummary |
withStatus(ZonalShiftStatus status)
A status for a zonal shift.
|
ZonalShiftSummary |
withZonalShiftId(String zonalShiftId)
The identifier of a zonal shift.
|
public void setAwayFrom(String awayFrom)
The Availability Zone 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 AWS Region.
awayFrom
- The Availability Zone 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 AWS Region.public String getAwayFrom()
The Availability Zone 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 AWS Region.
public ZonalShiftSummary withAwayFrom(String awayFrom)
The Availability Zone 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 AWS Region.
awayFrom
- The Availability Zone 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 AWS Region.public void setComment(String comment)
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.
comment
- 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.public String getComment()
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.
public ZonalShiftSummary withComment(String comment)
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.
comment
- 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.public void setExpiryTime(Date expiryTime)
The expiry time (expiration time) for the 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, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
expiryTime
- The expiry time (expiration time) for the 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, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
public Date getExpiryTime()
The expiry time (expiration time) for the 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, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
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, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
public ZonalShiftSummary withExpiryTime(Date expiryTime)
The expiry time (expiration time) for the 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, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
expiryTime
- The expiry time (expiration time) for the 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, for example, if you're ready to restore traffic to the Availability Zone. Or you can update the zonal shift to specify another length of time to expire in.
public void setResourceIdentifier(String resourceIdentifier)
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
resourceIdentifier
- The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name
(ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
public String getResourceIdentifier()
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
public ZonalShiftSummary withResourceIdentifier(String resourceIdentifier)
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
resourceIdentifier
- The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name
(ARN) for the resource.
At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.
public void setStartTime(Date startTime)
The time (UTC) when the zonal shift is started.
startTime
- The time (UTC) when the zonal shift is started.public Date getStartTime()
The time (UTC) when the zonal shift is started.
public ZonalShiftSummary withStartTime(Date startTime)
The time (UTC) when the zonal shift is started.
startTime
- The time (UTC) when the zonal shift is started.public void setStatus(String status)
A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
ACTIVE: The zonal shift is started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
status
- A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
ACTIVE: The zonal shift is started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
ZonalShiftStatus
public String getStatus()
A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
ACTIVE: The zonal shift is started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
The Status
for a zonal shift can have one of the following values:
ACTIVE: The zonal shift is started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
ZonalShiftStatus
public ZonalShiftSummary withStatus(String status)
A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
ACTIVE: The zonal shift is started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
status
- A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
ACTIVE: The zonal shift is started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
ZonalShiftStatus
public ZonalShiftSummary withStatus(ZonalShiftStatus status)
A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
ACTIVE: The zonal shift is started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
status
- A status for a zonal shift.
The Status
for a zonal shift can have one of the following values:
ACTIVE: The zonal shift is started and active.
EXPIRED: The zonal shift has expired (the expiry time was exceeded).
CANCELED: The zonal shift was canceled.
ZonalShiftStatus
public void setZonalShiftId(String zonalShiftId)
The identifier of a zonal shift.
zonalShiftId
- The identifier of a zonal shift.public String getZonalShiftId()
The identifier of a zonal shift.
public ZonalShiftSummary withZonalShiftId(String zonalShiftId)
The identifier of a zonal shift.
zonalShiftId
- The identifier of a zonal shift.public String toString()
toString
in class Object
Object.toString()
public ZonalShiftSummary clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.