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.UpdateZonalShift

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.

Synopsis

data UpdateZonalShift = UpdateZonalShift' {
- comment :: Maybe Text
- expiresIn :: Maybe Text
- zonalShiftId :: Text
}
newUpdateZonalShift :: Text -> UpdateZonalShift
updateZonalShift_comment :: Lens' UpdateZonalShift (Maybe Text)
updateZonalShift_expiresIn :: Lens' UpdateZonalShift (Maybe Text)
updateZonalShift_zonalShiftId :: Lens' UpdateZonalShift 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 UpdateZonalShift Source #

See: newUpdateZonalShift smart constructor.

Constructors

UpdateZonalShift'

Fields

comment :: Maybe 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 :: Maybe 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:
- 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).
zonalShiftId :: Text
The identifier of a zonal shift.

Instances

Instances details

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

newUpdateZonalShift Source #

Arguments

:: Text	`UpdateZonalShift`
-> UpdateZonalShift

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

UpdateZonalShift, updateZonalShift_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:UpdateZonalShift', updateZonalShift_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:

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).

UpdateZonalShift, updateZonalShift_zonalShiftId - The identifier of a zonal shift.

Request Lenses

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).

updateZonalShift_zonalShiftId :: Lens' UpdateZonalShift Text Source #

The identifier of a zonal shift.

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.