amazonka-arc-zonal-shift-2.0: Amazon ARC - Zonal Shift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ArcZonalShift.Lens

Description

 
Synopsis

Operations

CancelZonalShift

cancelZonalShift_zonalShiftId :: Lens' CancelZonalShift Text Source #

The internally-generated identifier of a zonal shift.

zonalShift_awayFrom :: Lens' ZonalShift Text Source #

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.

zonalShift_comment :: Lens' ZonalShift Text Source #

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.

zonalShift_expiryTime :: Lens' ZonalShift UTCTime Source #

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.

zonalShift_resourceIdentifier :: Lens' ZonalShift Text Source #

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.

zonalShift_startTime :: Lens' ZonalShift UTCTime Source #

The time (UTC) when the zonal shift is started.

zonalShift_status :: Lens' ZonalShift ZonalShiftStatus Source #

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.

zonalShift_zonalShiftId :: Lens' ZonalShift Text Source #

The identifier of a zonal shift.

GetManagedResource

getManagedResource_resourceIdentifier :: Lens' GetManagedResource Text Source #

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.

getManagedResourceResponse_arn :: Lens' GetManagedResourceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the resource.

getManagedResourceResponse_appliedWeights :: Lens' GetManagedResourceResponse (HashMap Text Double) Source #

A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.

getManagedResourceResponse_zonalShifts :: Lens' GetManagedResourceResponse [ZonalShiftInResource] Source #

The zonal shifts that are currently active for a resource.

ListManagedResources

listManagedResources_maxResults :: Lens' ListManagedResources (Maybe Natural) Source #

The number of objects that you want to return with this call.

listManagedResources_nextToken :: Lens' ListManagedResources (Maybe Text) Source #

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

listManagedResourcesResponse_nextToken :: Lens' ListManagedResourcesResponse (Maybe Text) Source #

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

ListZonalShifts

listZonalShifts_maxResults :: Lens' ListZonalShifts (Maybe Natural) Source #

The number of objects that you want to return with this call.

listZonalShifts_nextToken :: Lens' ListZonalShifts (Maybe Text) Source #

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

listZonalShifts_status :: Lens' ListZonalShifts (Maybe ZonalShiftStatus) Source #

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.

listZonalShiftsResponse_nextToken :: Lens' ListZonalShiftsResponse (Maybe Text) Source #

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

StartZonalShift

startZonalShift_awayFrom :: Lens' StartZonalShift Text Source #

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.

startZonalShift_comment :: Lens' StartZonalShift Text Source #

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.

startZonalShift_expiresIn :: Lens' StartZonalShift Text Source #

The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).

If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:

 <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p>

startZonalShift_resourceIdentifier :: Lens' StartZonalShift Text Source #

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.

zonalShift_awayFrom :: Lens' ZonalShift Text Source #

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.

zonalShift_comment :: Lens' ZonalShift Text Source #

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.

zonalShift_expiryTime :: Lens' ZonalShift UTCTime Source #

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.

zonalShift_resourceIdentifier :: Lens' ZonalShift Text Source #

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.

zonalShift_startTime :: Lens' ZonalShift UTCTime Source #

The time (UTC) when the zonal shift is started.

zonalShift_status :: Lens' ZonalShift ZonalShiftStatus Source #

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.

zonalShift_zonalShiftId :: Lens' ZonalShift Text Source #

The identifier of a zonal shift.

UpdateZonalShift

updateZonalShift_comment :: Lens' UpdateZonalShift (Maybe Text) Source #

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.

updateZonalShift_expiresIn :: Lens' UpdateZonalShift (Maybe Text) Source #

The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).

If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:

  • A lowercase letter m: To specify that the value is in minutes.
  • A lowercase letter h: To specify that the value is in hours.

For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).

zonalShift_awayFrom :: Lens' ZonalShift Text Source #

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.

zonalShift_comment :: Lens' ZonalShift Text Source #

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.

zonalShift_expiryTime :: Lens' ZonalShift UTCTime Source #

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.

zonalShift_resourceIdentifier :: Lens' ZonalShift Text Source #

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.

zonalShift_startTime :: Lens' ZonalShift UTCTime Source #

The time (UTC) when the zonal shift is started.

zonalShift_status :: Lens' ZonalShift ZonalShiftStatus Source #

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.

zonalShift_zonalShiftId :: Lens' ZonalShift Text Source #

The identifier of a zonal shift.

Types

ManagedResourceSummary

managedResourceSummary_arn :: Lens' ManagedResourceSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for the managed resource.

managedResourceSummary_availabilityZones :: Lens' ManagedResourceSummary [Text] Source #

The Availability Zones that a resource is deployed in.

ZonalShift

zonalShift_awayFrom :: Lens' ZonalShift Text Source #

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.

zonalShift_comment :: Lens' ZonalShift Text Source #

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.

zonalShift_expiryTime :: Lens' ZonalShift UTCTime Source #

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.

zonalShift_resourceIdentifier :: Lens' ZonalShift Text Source #

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.

zonalShift_startTime :: Lens' ZonalShift UTCTime Source #

The time (UTC) when the zonal shift is started.

zonalShift_status :: Lens' ZonalShift ZonalShiftStatus Source #

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.

zonalShift_zonalShiftId :: Lens' ZonalShift Text Source #

The identifier of a zonal shift.

ZonalShiftInResource

zonalShiftInResource_appliedStatus :: Lens' ZonalShiftInResource AppliedStatus Source #

An appliedStatus for a zonal shift for a resource can have one of two values: APPLIED or NOT_APPLIED.

zonalShiftInResource_awayFrom :: Lens' ZonalShiftInResource Text Source #

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.

zonalShiftInResource_comment :: Lens' ZonalShiftInResource Text Source #

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.

zonalShiftInResource_expiryTime :: Lens' ZonalShiftInResource UTCTime Source #

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.

zonalShiftInResource_resourceIdentifier :: Lens' ZonalShiftInResource Text Source #

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.

zonalShiftInResource_startTime :: Lens' ZonalShiftInResource UTCTime Source #

The time (UTC) when the zonal shift is started.

ZonalShiftSummary

zonalShiftSummary_awayFrom :: Lens' ZonalShiftSummary Text Source #

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.

zonalShiftSummary_comment :: Lens' ZonalShiftSummary Text Source #

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.

zonalShiftSummary_expiryTime :: Lens' ZonalShiftSummary UTCTime Source #

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.

zonalShiftSummary_resourceIdentifier :: Lens' ZonalShiftSummary Text Source #

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.

zonalShiftSummary_startTime :: Lens' ZonalShiftSummary UTCTime Source #

The time (UTC) when the zonal shift is started.

zonalShiftSummary_status :: Lens' ZonalShiftSummary ZonalShiftStatus Source #

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.