ZonalShiftSummary (AWS Java SDK :: Services :: ARC Zonal Shift 2.20.99 API)

java.lang.Object
- software.amazon.awssdk.services.arczonalshift.model.ZonalShiftSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ZonalShiftSummary.Builder,ZonalShiftSummary>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ZonalShiftSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ZonalShiftSummary.Builder,ZonalShiftSummary>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ZonalShiftSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ZonalShiftSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`awayFrom()` The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
`static ZonalShiftSummary.Builder`	`builder()`
`String`	`comment()` A comment that you enter about the zonal shift.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`expiryTime()` The expiry time (expiration time) for the zonal shift.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`resourceIdentifier()` The identifier for the resource to include in a zonal shift.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ZonalShiftSummary.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The time (UTC) when the zonal shift is started.
`ZonalShiftStatus`	`status()` A status for a zonal shift.
`String`	`statusAsString()` A status for a zonal shift.
`ZonalShiftSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`zonalShiftId()` The identifier of a zonal shift.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - awayFrom
```
public final 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.
    
    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.
  - comment
```
public final 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.
    
    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.
  - expiryTime
```
public final Instant 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:
    
    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.
  - resourceIdentifier
```
public final 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.
    
    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.
  - startTime
```
public final Instant startTime()
```
    The time (UTC) when the zonal shift is started.
    
    Returns:
    
    The time (UTC) when the zonal shift is started.
  - status
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, status will return ZonalShiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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
  - statusAsString
```
public final String statusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, status will return ZonalShiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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
  - zonalShiftId
```
public final String zonalShiftId()
```
    The identifier of a zonal shift.
    
    Returns:
    
    The identifier of a zonal shift.
  - toBuilder
```
public ZonalShiftSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ZonalShiftSummary.Builder,ZonalShiftSummary>
  - builder
```
public static ZonalShiftSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ZonalShiftSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ZonalShiftSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

awayFrom

comment

expiryTime

resourceIdentifier

startTime

status

statusAsString

zonalShiftId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields