Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ArcZonalShift.StartZonalShift

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region, to help 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. Resources are automatically registered with Route 53 ARC by AWS services.

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.

When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.

For more information, see Zonal shift in the Amazon Route 53 Application Recovery Controller Developer Guide.

Synopsis

data StartZonalShift = StartZonalShift' {
- awayFrom :: Text
- comment :: Text
- expiresIn :: Text
- resourceIdentifier :: Text
}
newStartZonalShift :: Text -> Text -> Text -> Text -> StartZonalShift
startZonalShift_awayFrom :: Lens' StartZonalShift Text
startZonalShift_comment :: Lens' StartZonalShift Text
startZonalShift_expiresIn :: Lens' StartZonalShift Text
startZonalShift_resourceIdentifier :: Lens' StartZonalShift Text
data ZonalShift = ZonalShift' {
- awayFrom :: Text
- comment :: Text
- expiryTime :: POSIX
- resourceIdentifier :: Text
- startTime :: POSIX
- status :: ZonalShiftStatus
- zonalShiftId :: Text
}
newZonalShift :: Text -> Text -> UTCTime -> Text -> UTCTime -> ZonalShiftStatus -> Text -> ZonalShift
zonalShift_awayFrom :: Lens' ZonalShift Text
zonalShift_comment :: Lens' ZonalShift Text
zonalShift_expiryTime :: Lens' ZonalShift UTCTime
zonalShift_resourceIdentifier :: Lens' ZonalShift Text
zonalShift_startTime :: Lens' ZonalShift UTCTime
zonalShift_status :: Lens' ZonalShift ZonalShiftStatus
zonalShift_zonalShiftId :: Lens' ZonalShift Text

Creating a Request

data StartZonalShift Source #

See: newStartZonalShift smart constructor.

Constructors

StartZonalShift'

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.
expiresIn :: Text
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> A lowercase letter m: To specify that the value is in minutes. </li> <li> A lowercase letter h: To specify that the value is in hours. </li> </ul> 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).
```
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.

Instances

Instances details

ToJSON StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods toJSON :: StartZonalShift -> Value # toEncoding :: StartZonalShift -> Encoding # toJSONList :: [StartZonalShift] -> Value # toEncodingList :: [StartZonalShift] -> Encoding #
ToHeaders StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods toHeaders :: StartZonalShift -> [Header] #
ToPath StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods toPath :: StartZonalShift -> ByteString #
ToQuery StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods toQuery :: StartZonalShift -> QueryString #
AWSRequest StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Associated Types type AWSResponse StartZonalShift # Methods request :: (Service -> Service) -> StartZonalShift -> Request StartZonalShift # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartZonalShift -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartZonalShift))) #
Generic StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Associated Types type Rep StartZonalShift :: Type -> Type # Methods from :: StartZonalShift -> Rep StartZonalShift x # to :: Rep StartZonalShift x -> StartZonalShift #
Read StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods readsPrec :: Int -> ReadS StartZonalShift # readList :: ReadS [StartZonalShift] # readPrec :: ReadPrec StartZonalShift # readListPrec :: ReadPrec [StartZonalShift] #
Show StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods showsPrec :: Int -> StartZonalShift -> ShowS # show :: StartZonalShift -> String # showList :: [StartZonalShift] -> ShowS #
NFData StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods rnf :: StartZonalShift -> () #
Eq StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods (==) :: StartZonalShift -> StartZonalShift -> Bool # (/=) :: StartZonalShift -> StartZonalShift -> Bool #
Hashable StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift Methods hashWithSalt :: Int -> StartZonalShift -> Int # hash :: StartZonalShift -> Int #
type AWSResponse StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift type AWSResponse StartZonalShift = ZonalShift
type Rep StartZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.StartZonalShift type Rep StartZonalShift = D1 ('MetaData "StartZonalShift" "Amazonka.ArcZonalShift.StartZonalShift" "amazonka-arc-zonal-shift-2.0-HIBvozV7Gpr4kwNpYeZSTq" 'False) (C1 ('MetaCons "StartZonalShift'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "awayFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartZonalShift Source #

Arguments

:: Text	`StartZonalShift`
-> Text	`StartZonalShift`
-> Text	`$sel:expiresIn:StartZonalShift'`
-> Text	`StartZonalShift`
-> StartZonalShift

Create a value of StartZonalShift 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:

StartZonalShift, startZonalShift_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.

StartZonalShift, startZonalShift_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:expiresIn:StartZonalShift', startZonalShift_expiresIn - 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, startZonalShift_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.

Request Lenses

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.

Destructuring the Response

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 Methods parseJSON :: Value -> Parser ZonalShift # parseJSONList :: Value -> Parser [ZonalShift] #
Generic ZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.Types.ZonalShift Associated Types type Rep ZonalShift :: Type -> Type # Methods from :: ZonalShift -> Rep ZonalShift x # to :: Rep ZonalShift x -> ZonalShift #
Read ZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.Types.ZonalShift Methods readsPrec :: Int -> ReadS ZonalShift # readList :: ReadS [ZonalShift] # readPrec :: ReadPrec ZonalShift # readListPrec :: ReadPrec [ZonalShift] #
Show ZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.Types.ZonalShift Methods showsPrec :: Int -> ZonalShift -> ShowS # show :: ZonalShift -> String # showList :: [ZonalShift] -> ShowS #
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 Methods (==) :: ZonalShift -> ZonalShift -> Bool # (/=) :: ZonalShift -> ZonalShift -> Bool #
Hashable ZonalShift Source #
Instance details Defined in Amazonka.ArcZonalShift.Types.ZonalShift Methods hashWithSalt :: Int -> ZonalShift -> Int # hash :: ZonalShift -> Int #
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 #

Arguments

:: Text	`$sel:awayFrom:ZonalShift'`
-> Text	`$sel:comment:ZonalShift'`
-> UTCTime	`$sel:expiryTime:ZonalShift'`
-> Text	`$sel:resourceIdentifier:ZonalShift'`
-> UTCTime	`$sel:startTime:ZonalShift'`
-> ZonalShiftStatus	`$sel:status:ZonalShift'`
-> Text	`$sel:zonalShiftId:ZonalShift'`
-> ZonalShift

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.

Response Lenses

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.