Class ZonalShiftInResource
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ZonalShiftInResource.Builder,
ZonalShiftInResource>
A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AppliedStatus
TheappliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one traffic shift active.final String
TheappliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one traffic shift active.final String
awayFrom()
The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.static ZonalShiftInResource.Builder
builder()
final String
comment()
A comment that you enter about the zonal shift.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Instant
The expiry time (expiration time) for a customer-started zonal shift.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final PracticeRunOutcome
The outcome, or end state, returned for a practice run.final String
The outcome, or end state, returned for a practice run.final String
The identifier for the resource to include in a zonal shift.static Class
<? extends ZonalShiftInResource.Builder> final Instant
The time (UTC) when the zonal shift starts.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The identifier of a zonal shift.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
appliedStatus
The
appliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one traffic shift active. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-started zonal shifts, or an autoshift. TheappliedStatus
field for an autoshift for a resource can have one of two values:APPLIED
orNOT_APPLIED
. The zonal shift or autoshift that is currently in effect for the resource has an applied status set toAPPLIED
.The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-started zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
If the service returns an enum value that is not available in the current SDK version,
appliedStatus
will returnAppliedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappliedStatusAsString()
.- Returns:
- The
appliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one traffic shift active. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-started zonal shifts, or an autoshift. TheappliedStatus
field for an autoshift for a resource can have one of two values:APPLIED
orNOT_APPLIED
. The zonal shift or autoshift that is currently in effect for the resource has an applied status set toAPPLIED
.The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-started zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
- See Also:
-
appliedStatusAsString
The
appliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one traffic shift active. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-started zonal shifts, or an autoshift. TheappliedStatus
field for an autoshift for a resource can have one of two values:APPLIED
orNOT_APPLIED
. The zonal shift or autoshift that is currently in effect for the resource has an applied status set toAPPLIED
.The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-started zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
If the service returns an enum value that is not available in the current SDK version,
appliedStatus
will returnAppliedStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappliedStatusAsString()
.- Returns:
- The
appliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one traffic shift active. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-started zonal shifts, or an autoshift. TheappliedStatus
field for an autoshift for a resource can have one of two values:APPLIED
orNOT_APPLIED
. The zonal shift or autoshift that is currently in effect for the resource has an applied status set toAPPLIED
.The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-started zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Route 53 Application Recovery Controller Developer Guide.
- See Also:
-
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 Amazon Web Services 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 Amazon Web Services Region.
-
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
The expiry time (expiration time) for a customer-started 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.
- Returns:
- The expiry time (expiration time) for a customer-started 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.
-
practiceRunOutcome
The outcome, or end state, returned for a practice run. The following values can be returned:
-
PENDING: Outcome value when a practice run is in progress.
-
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift. -
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
-
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
If the service returns an enum value that is not available in the current SDK version,
practiceRunOutcome
will returnPracticeRunOutcome.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompracticeRunOutcomeAsString()
.- Returns:
- The outcome, or end state, returned for a practice run. The following values can be returned:
-
PENDING: Outcome value when a practice run is in progress.
-
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift. -
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
-
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
-
- See Also:
-
-
practiceRunOutcomeAsString
The outcome, or end state, returned for a practice run. The following values can be returned:
-
PENDING: Outcome value when a practice run is in progress.
-
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift. -
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
-
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
If the service returns an enum value that is not available in the current SDK version,
practiceRunOutcome
will returnPracticeRunOutcome.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompracticeRunOutcomeAsString()
.- Returns:
- The outcome, or end state, returned for a practice run. The following values can be returned:
-
PENDING: Outcome value when a practice run is in progress.
-
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift. -
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
-
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide.
-
- See Also:
-
-
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
The time (UTC) when the zonal shift starts.
- Returns:
- The time (UTC) when the zonal shift starts.
-
zonalShiftId
The identifier of a zonal shift.
- Returns:
- The identifier of a zonal shift.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ZonalShiftInResource.Builder,
ZonalShiftInResource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-