Skip to content

Commit e4b4b31

Browse files
author
aws-sdk-cpp-automation
committed
Documentation updates to reflect service rename - AWS IAM Identity Center (successor to AWS Single Sign-On)
RDS for Oracle supports Oracle Data Guard switchover and read replica backups.
1 parent cde5c86 commit e4b4b31

File tree

12 files changed

+499
-12
lines changed

12 files changed

+499
-12
lines changed

aws-cpp-sdk-core/include/aws/core/VersionConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0.
44
*/
55

6-
#define AWS_SDK_VERSION_STRING 1.9.330
6+
#define AWS_SDK_VERSION_STRING 1.9.331
77
#define AWS_SDK_VERSION_MAJOR 1
88
#define AWS_SDK_VERSION_MINOR 9
9-
#define AWS_SDK_VERSION_PATCH 330
9+
#define AWS_SDK_VERSION_PATCH 331

aws-cpp-sdk-rds/include/aws/rds/RDSClient.h

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@
137137
#include <aws/rds/model/StopDBClusterResult.h>
138138
#include <aws/rds/model/StopDBInstanceResult.h>
139139
#include <aws/rds/model/StopDBInstanceAutomatedBackupsReplicationResult.h>
140+
#include <aws/rds/model/SwitchoverReadReplicaResult.h>
140141
#include <aws/core/NoResult.h>
141142
#include <aws/core/client/AsyncCallerContext.h>
142143
#include <aws/core/http/HttpTypes.h>
@@ -317,6 +318,7 @@ namespace Aws
317318
class StopDBClusterRequest;
318319
class StopDBInstanceRequest;
319320
class StopDBInstanceAutomatedBackupsReplicationRequest;
321+
class SwitchoverReadReplicaRequest;
320322

321323
typedef Aws::Utils::Outcome<Aws::NoResult, RDSError> AddRoleToDBClusterOutcome;
322324
typedef Aws::Utils::Outcome<Aws::NoResult, RDSError> AddRoleToDBInstanceOutcome;
@@ -454,6 +456,7 @@ namespace Aws
454456
typedef Aws::Utils::Outcome<StopDBClusterResult, RDSError> StopDBClusterOutcome;
455457
typedef Aws::Utils::Outcome<StopDBInstanceResult, RDSError> StopDBInstanceOutcome;
456458
typedef Aws::Utils::Outcome<StopDBInstanceAutomatedBackupsReplicationResult, RDSError> StopDBInstanceAutomatedBackupsReplicationOutcome;
459+
typedef Aws::Utils::Outcome<SwitchoverReadReplicaResult, RDSError> SwitchoverReadReplicaOutcome;
457460

458461
typedef std::future<AddRoleToDBClusterOutcome> AddRoleToDBClusterOutcomeCallable;
459462
typedef std::future<AddRoleToDBInstanceOutcome> AddRoleToDBInstanceOutcomeCallable;
@@ -591,6 +594,7 @@ namespace Aws
591594
typedef std::future<StopDBClusterOutcome> StopDBClusterOutcomeCallable;
592595
typedef std::future<StopDBInstanceOutcome> StopDBInstanceOutcomeCallable;
593596
typedef std::future<StopDBInstanceAutomatedBackupsReplicationOutcome> StopDBInstanceAutomatedBackupsReplicationOutcomeCallable;
597+
typedef std::future<SwitchoverReadReplicaOutcome> SwitchoverReadReplicaOutcomeCallable;
594598
} // namespace Model
595599

596600
class RDSClient;
@@ -731,6 +735,7 @@ namespace Aws
731735
typedef std::function<void(const RDSClient*, const Model::StopDBClusterRequest&, const Model::StopDBClusterOutcome&, const std::shared_ptr<const Aws::Client::AsyncCallerContext>&) > StopDBClusterResponseReceivedHandler;
732736
typedef std::function<void(const RDSClient*, const Model::StopDBInstanceRequest&, const Model::StopDBInstanceOutcome&, const std::shared_ptr<const Aws::Client::AsyncCallerContext>&) > StopDBInstanceResponseReceivedHandler;
733737
typedef std::function<void(const RDSClient*, const Model::StopDBInstanceAutomatedBackupsReplicationRequest&, const Model::StopDBInstanceAutomatedBackupsReplicationOutcome&, const std::shared_ptr<const Aws::Client::AsyncCallerContext>&) > StopDBInstanceAutomatedBackupsReplicationResponseReceivedHandler;
738+
typedef std::function<void(const RDSClient*, const Model::SwitchoverReadReplicaRequest&, const Model::SwitchoverReadReplicaOutcome&, const std::shared_ptr<const Aws::Client::AsyncCallerContext>&) > SwitchoverReadReplicaResponseReceivedHandler;
734739

735740
/**
736741
* <fullname>Amazon Relational Database Service</fullname> <p/> <p>Amazon
@@ -4026,6 +4031,25 @@ namespace Aws
40264031
*/
40274032
virtual void StopDBInstanceAutomatedBackupsReplicationAsync(const Model::StopDBInstanceAutomatedBackupsReplicationRequest& request, const StopDBInstanceAutomatedBackupsReplicationResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const;
40284033

4034+
/**
4035+
* <p>Switches over an Oracle standby database in an Oracle Data Guard environment,
4036+
* making it the new primary database. Issue this command in the AWS Region that
4037+
* hosts the current standby database.</p><p><h3>See Also:</h3> <a
4038+
* href="http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SwitchoverReadReplica">AWS
4039+
* API Reference</a></p>
4040+
*/
4041+
virtual Model::SwitchoverReadReplicaOutcome SwitchoverReadReplica(const Model::SwitchoverReadReplicaRequest& request) const;
4042+
4043+
/**
4044+
* A Callable wrapper for SwitchoverReadReplica that returns a future to the operation so that it can be executed in parallel to other requests.
4045+
*/
4046+
virtual Model::SwitchoverReadReplicaOutcomeCallable SwitchoverReadReplicaCallable(const Model::SwitchoverReadReplicaRequest& request) const;
4047+
4048+
/**
4049+
* An Async wrapper for SwitchoverReadReplica that queues the request into a thread executor and triggers associated callback when operation has finished.
4050+
*/
4051+
virtual void SwitchoverReadReplicaAsync(const Model::SwitchoverReadReplicaRequest& request, const SwitchoverReadReplicaResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const;
4052+
40294053

40304054
void OverrideEndpoint(const Aws::String& endpoint);
40314055
private:
@@ -4166,6 +4190,7 @@ namespace Aws
41664190
void StopDBClusterAsyncHelper(const Model::StopDBClusterRequest& request, const StopDBClusterResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context) const;
41674191
void StopDBInstanceAsyncHelper(const Model::StopDBInstanceRequest& request, const StopDBInstanceResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context) const;
41684192
void StopDBInstanceAutomatedBackupsReplicationAsyncHelper(const Model::StopDBInstanceAutomatedBackupsReplicationRequest& request, const StopDBInstanceAutomatedBackupsReplicationResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context) const;
4193+
void SwitchoverReadReplicaAsyncHelper(const Model::SwitchoverReadReplicaRequest& request, const SwitchoverReadReplicaResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context) const;
41694194

41704195
Aws::String m_uri;
41714196
Aws::String m_configScheme;

aws-cpp-sdk-rds/include/aws/rds/model/DBSnapshot.h

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1243,6 +1243,85 @@ namespace Model
12431243
inline DBSnapshot& WithOriginalSnapshotCreateTime(Aws::Utils::DateTime&& value) { SetOriginalSnapshotCreateTime(std::move(value)); return *this;}
12441244

12451245

1246+
/**
1247+
* <p>The timestamp of the most recent transaction applied to the database that
1248+
* you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the
1249+
* most recent transaction in the restored DB instance. In contrast,
1250+
* originalSnapshotCreateTime specifies the system time that the snapshot
1251+
* completed.</p> <p>If you back up a read replica, you can determine the replica
1252+
* lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For
1253+
* example, if originalSnapshotCreateTime is two hours later than
1254+
* SnapshotDatabaseTime, then the replica lag is two hours. *** REVIEWERS 7/27:
1255+
* Switchover</p>
1256+
*/
1257+
inline const Aws::Utils::DateTime& GetSnapshotDatabaseTime() const{ return m_snapshotDatabaseTime; }
1258+
1259+
/**
1260+
* <p>The timestamp of the most recent transaction applied to the database that
1261+
* you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the
1262+
* most recent transaction in the restored DB instance. In contrast,
1263+
* originalSnapshotCreateTime specifies the system time that the snapshot
1264+
* completed.</p> <p>If you back up a read replica, you can determine the replica
1265+
* lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For
1266+
* example, if originalSnapshotCreateTime is two hours later than
1267+
* SnapshotDatabaseTime, then the replica lag is two hours. *** REVIEWERS 7/27:
1268+
* Switchover</p>
1269+
*/
1270+
inline bool SnapshotDatabaseTimeHasBeenSet() const { return m_snapshotDatabaseTimeHasBeenSet; }
1271+
1272+
/**
1273+
* <p>The timestamp of the most recent transaction applied to the database that
1274+
* you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the
1275+
* most recent transaction in the restored DB instance. In contrast,
1276+
* originalSnapshotCreateTime specifies the system time that the snapshot
1277+
* completed.</p> <p>If you back up a read replica, you can determine the replica
1278+
* lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For
1279+
* example, if originalSnapshotCreateTime is two hours later than
1280+
* SnapshotDatabaseTime, then the replica lag is two hours. *** REVIEWERS 7/27:
1281+
* Switchover</p>
1282+
*/
1283+
inline void SetSnapshotDatabaseTime(const Aws::Utils::DateTime& value) { m_snapshotDatabaseTimeHasBeenSet = true; m_snapshotDatabaseTime = value; }
1284+
1285+
/**
1286+
* <p>The timestamp of the most recent transaction applied to the database that
1287+
* you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the
1288+
* most recent transaction in the restored DB instance. In contrast,
1289+
* originalSnapshotCreateTime specifies the system time that the snapshot
1290+
* completed.</p> <p>If you back up a read replica, you can determine the replica
1291+
* lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For
1292+
* example, if originalSnapshotCreateTime is two hours later than
1293+
* SnapshotDatabaseTime, then the replica lag is two hours. *** REVIEWERS 7/27:
1294+
* Switchover</p>
1295+
*/
1296+
inline void SetSnapshotDatabaseTime(Aws::Utils::DateTime&& value) { m_snapshotDatabaseTimeHasBeenSet = true; m_snapshotDatabaseTime = std::move(value); }
1297+
1298+
/**
1299+
* <p>The timestamp of the most recent transaction applied to the database that
1300+
* you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the
1301+
* most recent transaction in the restored DB instance. In contrast,
1302+
* originalSnapshotCreateTime specifies the system time that the snapshot
1303+
* completed.</p> <p>If you back up a read replica, you can determine the replica
1304+
* lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For
1305+
* example, if originalSnapshotCreateTime is two hours later than
1306+
* SnapshotDatabaseTime, then the replica lag is two hours. *** REVIEWERS 7/27:
1307+
* Switchover</p>
1308+
*/
1309+
inline DBSnapshot& WithSnapshotDatabaseTime(const Aws::Utils::DateTime& value) { SetSnapshotDatabaseTime(value); return *this;}
1310+
1311+
/**
1312+
* <p>The timestamp of the most recent transaction applied to the database that
1313+
* you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the
1314+
* most recent transaction in the restored DB instance. In contrast,
1315+
* originalSnapshotCreateTime specifies the system time that the snapshot
1316+
* completed.</p> <p>If you back up a read replica, you can determine the replica
1317+
* lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For
1318+
* example, if originalSnapshotCreateTime is two hours later than
1319+
* SnapshotDatabaseTime, then the replica lag is two hours. *** REVIEWERS 7/27:
1320+
* Switchover</p>
1321+
*/
1322+
inline DBSnapshot& WithSnapshotDatabaseTime(Aws::Utils::DateTime&& value) { SetSnapshotDatabaseTime(std::move(value)); return *this;}
1323+
1324+
12461325
/**
12471326
* <p>Specifies where manual snapshots are stored: Amazon Web Services Outposts or
12481327
* the Amazon Web Services Region.</p>
@@ -1383,6 +1462,9 @@ namespace Model
13831462
Aws::Utils::DateTime m_originalSnapshotCreateTime;
13841463
bool m_originalSnapshotCreateTimeHasBeenSet;
13851464

1465+
Aws::Utils::DateTime m_snapshotDatabaseTime;
1466+
bool m_snapshotDatabaseTimeHasBeenSet;
1467+
13861468
Aws::String m_snapshotTarget;
13871469
bool m_snapshotTargetHasBeenSet;
13881470
};
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
/**
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
* SPDX-License-Identifier: Apache-2.0.
4+
*/
5+
6+
#pragma once
7+
#include <aws/rds/RDS_EXPORTS.h>
8+
#include <aws/rds/RDSRequest.h>
9+
#include <aws/core/utils/memory/stl/AWSString.h>
10+
#include <utility>
11+
12+
namespace Aws
13+
{
14+
namespace RDS
15+
{
16+
namespace Model
17+
{
18+
19+
/**
20+
*/
21+
class AWS_RDS_API SwitchoverReadReplicaRequest : public RDSRequest
22+
{
23+
public:
24+
SwitchoverReadReplicaRequest();
25+
26+
// Service request name is the Operation name which will send this request out,
27+
// each operation should has unique request name, so that we can get operation's name from this request.
28+
// Note: this is not true for response, multiple operations may have the same response name,
29+
// so we can not get operation's name from response.
30+
inline virtual const char* GetServiceRequestName() const override { return "SwitchoverReadReplica"; }
31+
32+
Aws::String SerializePayload() const override;
33+
34+
protected:
35+
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
36+
37+
public:
38+
39+
/**
40+
* <p>The DB instance identifier of the current standby database. This value is
41+
* stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match
42+
* the identifier of an existing Oracle read replica DB instance.</p> </li> </ul>
43+
*/
44+
inline const Aws::String& GetDBInstanceIdentifier() const{ return m_dBInstanceIdentifier; }
45+
46+
/**
47+
* <p>The DB instance identifier of the current standby database. This value is
48+
* stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match
49+
* the identifier of an existing Oracle read replica DB instance.</p> </li> </ul>
50+
*/
51+
inline bool DBInstanceIdentifierHasBeenSet() const { return m_dBInstanceIdentifierHasBeenSet; }
52+
53+
/**
54+
* <p>The DB instance identifier of the current standby database. This value is
55+
* stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match
56+
* the identifier of an existing Oracle read replica DB instance.</p> </li> </ul>
57+
*/
58+
inline void SetDBInstanceIdentifier(const Aws::String& value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier = value; }
59+
60+
/**
61+
* <p>The DB instance identifier of the current standby database. This value is
62+
* stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match
63+
* the identifier of an existing Oracle read replica DB instance.</p> </li> </ul>
64+
*/
65+
inline void SetDBInstanceIdentifier(Aws::String&& value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier = std::move(value); }
66+
67+
/**
68+
* <p>The DB instance identifier of the current standby database. This value is
69+
* stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match
70+
* the identifier of an existing Oracle read replica DB instance.</p> </li> </ul>
71+
*/
72+
inline void SetDBInstanceIdentifier(const char* value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier.assign(value); }
73+
74+
/**
75+
* <p>The DB instance identifier of the current standby database. This value is
76+
* stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match
77+
* the identifier of an existing Oracle read replica DB instance.</p> </li> </ul>
78+
*/
79+
inline SwitchoverReadReplicaRequest& WithDBInstanceIdentifier(const Aws::String& value) { SetDBInstanceIdentifier(value); return *this;}
80+
81+
/**
82+
* <p>The DB instance identifier of the current standby database. This value is
83+
* stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match
84+
* the identifier of an existing Oracle read replica DB instance.</p> </li> </ul>
85+
*/
86+
inline SwitchoverReadReplicaRequest& WithDBInstanceIdentifier(Aws::String&& value) { SetDBInstanceIdentifier(std::move(value)); return *this;}
87+
88+
/**
89+
* <p>The DB instance identifier of the current standby database. This value is
90+
* stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match
91+
* the identifier of an existing Oracle read replica DB instance.</p> </li> </ul>
92+
*/
93+
inline SwitchoverReadReplicaRequest& WithDBInstanceIdentifier(const char* value) { SetDBInstanceIdentifier(value); return *this;}
94+
95+
private:
96+
97+
Aws::String m_dBInstanceIdentifier;
98+
bool m_dBInstanceIdentifierHasBeenSet;
99+
};
100+
101+
} // namespace Model
102+
} // namespace RDS
103+
} // namespace Aws
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
/**
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
* SPDX-License-Identifier: Apache-2.0.
4+
*/
5+
6+
#pragma once
7+
#include <aws/rds/RDS_EXPORTS.h>
8+
#include <aws/rds/model/DBInstance.h>
9+
#include <aws/rds/model/ResponseMetadata.h>
10+
#include <utility>
11+
12+
namespace Aws
13+
{
14+
template<typename RESULT_TYPE>
15+
class AmazonWebServiceResult;
16+
17+
namespace Utils
18+
{
19+
namespace Xml
20+
{
21+
class XmlDocument;
22+
} // namespace Xml
23+
} // namespace Utils
24+
namespace RDS
25+
{
26+
namespace Model
27+
{
28+
class AWS_RDS_API SwitchoverReadReplicaResult
29+
{
30+
public:
31+
SwitchoverReadReplicaResult();
32+
SwitchoverReadReplicaResult(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result);
33+
SwitchoverReadReplicaResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Xml::XmlDocument>& result);
34+
35+
36+
37+
inline const DBInstance& GetDBInstance() const{ return m_dBInstance; }
38+
39+
40+
inline void SetDBInstance(const DBInstance& value) { m_dBInstance = value; }
41+
42+
43+
inline void SetDBInstance(DBInstance&& value) { m_dBInstance = std::move(value); }
44+
45+
46+
inline SwitchoverReadReplicaResult& WithDBInstance(const DBInstance& value) { SetDBInstance(value); return *this;}
47+
48+
49+
inline SwitchoverReadReplicaResult& WithDBInstance(DBInstance&& value) { SetDBInstance(std::move(value)); return *this;}
50+
51+
52+
53+
inline const ResponseMetadata& GetResponseMetadata() const{ return m_responseMetadata; }
54+
55+
56+
inline void SetResponseMetadata(const ResponseMetadata& value) { m_responseMetadata = value; }
57+
58+
59+
inline void SetResponseMetadata(ResponseMetadata&& value) { m_responseMetadata = std::move(value); }
60+
61+
62+
inline SwitchoverReadReplicaResult& WithResponseMetadata(const ResponseMetadata& value) { SetResponseMetadata(value); return *this;}
63+
64+
65+
inline SwitchoverReadReplicaResult& WithResponseMetadata(ResponseMetadata&& value) { SetResponseMetadata(std::move(value)); return *this;}
66+
67+
private:
68+
69+
DBInstance m_dBInstance;
70+
71+
ResponseMetadata m_responseMetadata;
72+
};
73+
74+
} // namespace Model
75+
} // namespace RDS
76+
} // namespace Aws

0 commit comments

Comments
 (0)