ZonalShiftSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.arczonalshift.model.ZonalShiftSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ZonalShiftSummary()

Constructors
Constructor and Description
`ZonalShiftSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ZonalShiftSummary
```
public ZonalShiftSummary()
```
- Method Detail
  - setAwayFrom
```
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.
    
    Parameters:
    
    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.
  - getAwayFrom
```
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.
    
    Returns:
    
    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.
  - withAwayFrom
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComment
```
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.
    
    Parameters:
    
    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.
  - getComment
```
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.
    
    Returns:
    
    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.
  - withComment
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpiryTime
```
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.
    
    Parameters:
    
    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.
  - getExpiryTime
```
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.
    
    Returns:
    
    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.
  - withExpiryTime
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceIdentifier
```
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.
    
    Parameters:
    
    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.
  - getResourceIdentifier
```
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.
    
    Returns:
    
    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.
  - withResourceIdentifier
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The time (UTC) when the zonal shift is started.
    
    Parameters:
    
    startTime - The time (UTC) when the zonal shift is started.
  - getStartTime
```
public Date getStartTime()
```
    The time (UTC) when the zonal shift is started.
    
    Returns:
    
    The time (UTC) when the zonal shift is started.
  - withStartTime
```
public ZonalShiftSummary withStartTime(Date startTime)
```
    The time (UTC) when the zonal shift is started.
    
    Parameters:
    
    startTime - The time (UTC) when the zonal shift is started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
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.
    Parameters:
    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.
    See Also:
    
    ZonalShiftStatus
  - getStatus
```
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.
    Returns:
    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.
    See Also:
    
    ZonalShiftStatus
  - withStatus
```
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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ZonalShiftStatus
  - withStatus
```
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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ZonalShiftStatus
  - setZonalShiftId
```
public void setZonalShiftId(String zonalShiftId)
```
    The identifier of a zonal shift.
    
    Parameters:
    
    zonalShiftId - The identifier of a zonal shift.
  - getZonalShiftId
```
public String getZonalShiftId()
```
    The identifier of a zonal shift.
    
    Returns:
    
    The identifier of a zonal shift.
  - withZonalShiftId
```
public ZonalShiftSummary withZonalShiftId(String zonalShiftId)
```
    The identifier of a zonal shift.
    
    Parameters:
    
    zonalShiftId - The identifier of a zonal shift.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ZonalShiftSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ZonalShiftSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZonalShiftSummary

Method Detail

setAwayFrom

getAwayFrom

withAwayFrom

setComment

getComment

withComment

setExpiryTime

getExpiryTime

withExpiryTime

setResourceIdentifier

getResourceIdentifier

withResourceIdentifier

setStartTime

getStartTime

withStartTime

setStatus

getStatus

withStatus

withStatus

setZonalShiftId

getZonalShiftId

withZonalShiftId

toString

equals

hashCode

clone

marshall