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.RDS.SwitchoverBlueGreenDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Switches over a blue/green deployment.

Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Synopsis

data SwitchoverBlueGreenDeployment = SwitchoverBlueGreenDeployment' {
- switchoverTimeout :: Maybe Natural
- blueGreenDeploymentIdentifier :: Text
}
newSwitchoverBlueGreenDeployment :: Text -> SwitchoverBlueGreenDeployment
switchoverBlueGreenDeployment_switchoverTimeout :: Lens' SwitchoverBlueGreenDeployment (Maybe Natural)
switchoverBlueGreenDeployment_blueGreenDeploymentIdentifier :: Lens' SwitchoverBlueGreenDeployment Text
data SwitchoverBlueGreenDeploymentResponse = SwitchoverBlueGreenDeploymentResponse' {
- blueGreenDeployment :: Maybe BlueGreenDeployment
- httpStatus :: Int
}
newSwitchoverBlueGreenDeploymentResponse :: Int -> SwitchoverBlueGreenDeploymentResponse
switchoverBlueGreenDeploymentResponse_blueGreenDeployment :: Lens' SwitchoverBlueGreenDeploymentResponse (Maybe BlueGreenDeployment)
switchoverBlueGreenDeploymentResponse_httpStatus :: Lens' SwitchoverBlueGreenDeploymentResponse Int

Creating a Request

data SwitchoverBlueGreenDeployment Source #

See: newSwitchoverBlueGreenDeployment smart constructor.

Constructors

SwitchoverBlueGreenDeployment'

Fields

switchoverTimeout :: Maybe Natural
The amount of time, in seconds, for the switchover to complete. The default is 300.
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.
blueGreenDeploymentIdentifier :: Text
The blue/green deployment identifier.
Constraints:
- Must match an existing blue/green deployment identifier.

Instances

Instances details

ToHeaders SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods toHeaders :: SwitchoverBlueGreenDeployment -> [Header] #
ToPath SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods toPath :: SwitchoverBlueGreenDeployment -> ByteString #
ToQuery SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods toQuery :: SwitchoverBlueGreenDeployment -> QueryString #
AWSRequest SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Associated Types type AWSResponse SwitchoverBlueGreenDeployment # Methods request :: (Service -> Service) -> SwitchoverBlueGreenDeployment -> Request SwitchoverBlueGreenDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SwitchoverBlueGreenDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SwitchoverBlueGreenDeployment))) #
Generic SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Associated Types type Rep SwitchoverBlueGreenDeployment :: Type -> Type # Methods from :: SwitchoverBlueGreenDeployment -> Rep SwitchoverBlueGreenDeployment x # to :: Rep SwitchoverBlueGreenDeployment x -> SwitchoverBlueGreenDeployment #
Read SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods readsPrec :: Int -> ReadS SwitchoverBlueGreenDeployment # readList :: ReadS [SwitchoverBlueGreenDeployment] # readPrec :: ReadPrec SwitchoverBlueGreenDeployment # readListPrec :: ReadPrec [SwitchoverBlueGreenDeployment] #
Show SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods showsPrec :: Int -> SwitchoverBlueGreenDeployment -> ShowS # show :: SwitchoverBlueGreenDeployment -> String # showList :: [SwitchoverBlueGreenDeployment] -> ShowS #
NFData SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods rnf :: SwitchoverBlueGreenDeployment -> () #
Eq SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods (==) :: SwitchoverBlueGreenDeployment -> SwitchoverBlueGreenDeployment -> Bool # (/=) :: SwitchoverBlueGreenDeployment -> SwitchoverBlueGreenDeployment -> Bool #
Hashable SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods hashWithSalt :: Int -> SwitchoverBlueGreenDeployment -> Int # hash :: SwitchoverBlueGreenDeployment -> Int #
type AWSResponse SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment type AWSResponse SwitchoverBlueGreenDeployment = SwitchoverBlueGreenDeploymentResponse
type Rep SwitchoverBlueGreenDeployment Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment type Rep SwitchoverBlueGreenDeployment = D1 ('MetaData "SwitchoverBlueGreenDeployment" "Amazonka.RDS.SwitchoverBlueGreenDeployment" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "SwitchoverBlueGreenDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "switchoverTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "blueGreenDeploymentIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSwitchoverBlueGreenDeployment Source #

Arguments

:: Text	`SwitchoverBlueGreenDeployment`
-> SwitchoverBlueGreenDeployment

Create a value of SwitchoverBlueGreenDeployment 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:switchoverTimeout:SwitchoverBlueGreenDeployment', switchoverBlueGreenDeployment_switchoverTimeout - The amount of time, in seconds, for the switchover to complete. The default is 300.

If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.

SwitchoverBlueGreenDeployment, switchoverBlueGreenDeployment_blueGreenDeploymentIdentifier - The blue/green deployment identifier.

Constraints:

Must match an existing blue/green deployment identifier.

Request Lenses

switchoverBlueGreenDeployment_switchoverTimeout :: Lens' SwitchoverBlueGreenDeployment (Maybe Natural) Source #

The amount of time, in seconds, for the switchover to complete. The default is 300.

If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.

switchoverBlueGreenDeployment_blueGreenDeploymentIdentifier :: Lens' SwitchoverBlueGreenDeployment Text Source #

The blue/green deployment identifier.

Constraints:

Must match an existing blue/green deployment identifier.

Destructuring the Response

data SwitchoverBlueGreenDeploymentResponse Source #

See: newSwitchoverBlueGreenDeploymentResponse smart constructor.

Constructors

SwitchoverBlueGreenDeploymentResponse'
Fields blueGreenDeployment :: Maybe BlueGreenDeployment httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SwitchoverBlueGreenDeploymentResponse Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Associated Types type Rep SwitchoverBlueGreenDeploymentResponse :: Type -> Type # Methods from :: SwitchoverBlueGreenDeploymentResponse -> Rep SwitchoverBlueGreenDeploymentResponse x # to :: Rep SwitchoverBlueGreenDeploymentResponse x -> SwitchoverBlueGreenDeploymentResponse #
Read SwitchoverBlueGreenDeploymentResponse Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods readsPrec :: Int -> ReadS SwitchoverBlueGreenDeploymentResponse # readList :: ReadS [SwitchoverBlueGreenDeploymentResponse] # readPrec :: ReadPrec SwitchoverBlueGreenDeploymentResponse # readListPrec :: ReadPrec [SwitchoverBlueGreenDeploymentResponse] #
Show SwitchoverBlueGreenDeploymentResponse Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods showsPrec :: Int -> SwitchoverBlueGreenDeploymentResponse -> ShowS # show :: SwitchoverBlueGreenDeploymentResponse -> String # showList :: [SwitchoverBlueGreenDeploymentResponse] -> ShowS #
NFData SwitchoverBlueGreenDeploymentResponse Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods rnf :: SwitchoverBlueGreenDeploymentResponse -> () #
Eq SwitchoverBlueGreenDeploymentResponse Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment Methods (==) :: SwitchoverBlueGreenDeploymentResponse -> SwitchoverBlueGreenDeploymentResponse -> Bool # (/=) :: SwitchoverBlueGreenDeploymentResponse -> SwitchoverBlueGreenDeploymentResponse -> Bool #
type Rep SwitchoverBlueGreenDeploymentResponse Source #
Instance details Defined in Amazonka.RDS.SwitchoverBlueGreenDeployment type Rep SwitchoverBlueGreenDeploymentResponse = D1 ('MetaData "SwitchoverBlueGreenDeploymentResponse" "Amazonka.RDS.SwitchoverBlueGreenDeployment" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "SwitchoverBlueGreenDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "blueGreenDeployment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BlueGreenDeployment)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSwitchoverBlueGreenDeploymentResponse Source #

Arguments

:: Int	`$sel:httpStatus:SwitchoverBlueGreenDeploymentResponse'`
-> SwitchoverBlueGreenDeploymentResponse

Create a value of SwitchoverBlueGreenDeploymentResponse 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:blueGreenDeployment:SwitchoverBlueGreenDeploymentResponse', switchoverBlueGreenDeploymentResponse_blueGreenDeployment - Undocumented member.

$sel:httpStatus:SwitchoverBlueGreenDeploymentResponse', switchoverBlueGreenDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

switchoverBlueGreenDeploymentResponse_blueGreenDeployment :: Lens' SwitchoverBlueGreenDeploymentResponse (Maybe BlueGreenDeployment) Source #

Undocumented member.

switchoverBlueGreenDeploymentResponse_httpStatus :: Lens' SwitchoverBlueGreenDeploymentResponse Int Source #

The response's http status code.