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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a blue/green deployment.

A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

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

Creating a Request

data CreateBlueGreenDeployment Source #

See: newCreateBlueGreenDeployment smart constructor.

Constructors

CreateBlueGreenDeployment'

Fields

tags :: Maybe [Tag]
Tags to assign to the blue/green deployment.
targetDBClusterParameterGroupName :: Maybe Text
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.
targetDBParameterGroupName :: Maybe Text
The DB parameter group associated with the DB instance in the green environment.
To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
targetEngineVersion :: Maybe Text
The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
blueGreenDeploymentName :: Text
The name of the blue/green deployment.
Constraints:
- Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
source :: Text
The Amazon Resource Name (ARN) of the source production database.
Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.

Instances

Instances details

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

newCreateBlueGreenDeployment Source #

Arguments

:: Text	`CreateBlueGreenDeployment`
-> Text	`CreateBlueGreenDeployment`
-> CreateBlueGreenDeployment

Create a value of CreateBlueGreenDeployment 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:tags:CreateBlueGreenDeployment', createBlueGreenDeployment_tags - Tags to assign to the blue/green deployment.

$sel:targetDBClusterParameterGroupName:CreateBlueGreenDeployment', createBlueGreenDeployment_targetDBClusterParameterGroupName - The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.

$sel:targetDBParameterGroupName:CreateBlueGreenDeployment', createBlueGreenDeployment_targetDBParameterGroupName - The DB parameter group associated with the DB instance in the green environment.

To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.

$sel:targetEngineVersion:CreateBlueGreenDeployment', createBlueGreenDeployment_targetEngineVersion - The engine version of the database in the green environment.

Specify the engine version to upgrade to in the green environment.

CreateBlueGreenDeployment, createBlueGreenDeployment_blueGreenDeploymentName - The name of the blue/green deployment.

Constraints:

Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

CreateBlueGreenDeployment, createBlueGreenDeployment_source - The Amazon Resource Name (ARN) of the source production database.

Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.

Request Lenses

createBlueGreenDeployment_tags :: Lens' CreateBlueGreenDeployment (Maybe [Tag]) Source #

Tags to assign to the blue/green deployment.

createBlueGreenDeployment_targetDBClusterParameterGroupName :: Lens' CreateBlueGreenDeployment (Maybe Text) Source #

The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.

createBlueGreenDeployment_targetDBParameterGroupName :: Lens' CreateBlueGreenDeployment (Maybe Text) Source #

The DB parameter group associated with the DB instance in the green environment.

To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.

createBlueGreenDeployment_targetEngineVersion :: Lens' CreateBlueGreenDeployment (Maybe Text) Source #

The engine version of the database in the green environment.

Specify the engine version to upgrade to in the green environment.

createBlueGreenDeployment_blueGreenDeploymentName :: Lens' CreateBlueGreenDeployment Text Source #

The name of the blue/green deployment.

Constraints:

Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

createBlueGreenDeployment_source :: Lens' CreateBlueGreenDeployment Text Source #

The Amazon Resource Name (ARN) of the source production database.

Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.

Destructuring the Response

data CreateBlueGreenDeploymentResponse Source #

See: newCreateBlueGreenDeploymentResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateBlueGreenDeploymentResponse Source #

Arguments

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

Create a value of CreateBlueGreenDeploymentResponse 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:CreateBlueGreenDeploymentResponse', createBlueGreenDeploymentResponse_blueGreenDeployment - Undocumented member.

$sel:httpStatus:CreateBlueGreenDeploymentResponse', createBlueGreenDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

createBlueGreenDeploymentResponse_blueGreenDeployment :: Lens' CreateBlueGreenDeploymentResponse (Maybe BlueGreenDeployment) Source #

Undocumented member.

createBlueGreenDeploymentResponse_httpStatus :: Lens' CreateBlueGreenDeploymentResponse Int Source #

The response's http status code.