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.Types.ZonalShift

Description

 
Synopsis

Documentation

data ZonalShift Source #

See: newZonalShift smart constructor.

Constructors

ZonalShift' 

Fields

  • awayFrom :: Text

    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 :: Text

    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.

  • expiryTime :: POSIX

    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 :: Text

    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 :: POSIX

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

  • status :: ZonalShiftStatus

    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.
  • zonalShiftId :: Text

    The identifier of a zonal shift.

Instances

Instances details
FromJSON ZonalShift Source # 
Instance details

Defined in Amazonka.ArcZonalShift.Types.ZonalShift

Generic ZonalShift Source # 
Instance details

Defined in Amazonka.ArcZonalShift.Types.ZonalShift

Associated Types

type Rep ZonalShift :: Type -> Type #

Read ZonalShift Source # 
Instance details

Defined in Amazonka.ArcZonalShift.Types.ZonalShift

Show ZonalShift Source # 
Instance details

Defined in Amazonka.ArcZonalShift.Types.ZonalShift

NFData ZonalShift Source # 
Instance details

Defined in Amazonka.ArcZonalShift.Types.ZonalShift

Methods

rnf :: ZonalShift -> () #

Eq ZonalShift Source # 
Instance details

Defined in Amazonka.ArcZonalShift.Types.ZonalShift

Hashable ZonalShift Source # 
Instance details

Defined in Amazonka.ArcZonalShift.Types.ZonalShift

type Rep ZonalShift Source # 
Instance details

Defined in Amazonka.ArcZonalShift.Types.ZonalShift

type Rep ZonalShift = D1 ('MetaData "ZonalShift" "Amazonka.ArcZonalShift.Types.ZonalShift" "amazonka-arc-zonal-shift-2.0-HIBvozV7Gpr4kwNpYeZSTq" 'False) (C1 ('MetaCons "ZonalShift'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "awayFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "expiryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :*: ((S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ZonalShiftStatus) :*: S1 ('MetaSel ('Just "zonalShiftId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newZonalShift Source #

Create a value of ZonalShift with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:awayFrom:ZonalShift', zonalShift_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.

$sel:comment:ZonalShift', zonalShift_comment - 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.

$sel:expiryTime:ZonalShift', zonalShift_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.

$sel:resourceIdentifier:ZonalShift', zonalShift_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.

$sel:startTime:ZonalShift', zonalShift_startTime - The time (UTC) when the zonal shift is started.

$sel:status:ZonalShift', zonalShift_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.

$sel:zonalShiftId:ZonalShift', zonalShift_zonalShiftId - The 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.