Skip to content

Commit 45b7a42

Browse files
Added major version upgrade option in ModifyDBCluster API
1 parent 2755317 commit 45b7a42

File tree

11 files changed

+76
-12
lines changed

11 files changed

+76
-12
lines changed

generator/ServiceModels/docdb/docdb-2014-10-31.api.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2511,6 +2511,7 @@
25112511
"PreferredMaintenanceWindow":{"shape":"String"},
25122512
"CloudwatchLogsExportConfiguration":{"shape":"CloudwatchLogsExportConfiguration"},
25132513
"EngineVersion":{"shape":"String"},
2514+
"AllowMajorVersionUpgrade":{"shape":"Boolean"},
25142515
"DeletionProtection":{"shape":"BooleanOptional"}
25152516
}
25162517
},

generator/ServiceModels/docdb/docdb-2014-10-31.docs.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"version": "2.0",
3-
"service": "<p>Amazon DocumentDB API documentation</p>",
3+
"service": "<p>Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.</p>",
44
"operations": {
55
"AddSourceIdentifierToSubscription": "<p>Adds a source identifier to an existing event notification subscription.</p>",
66
"AddTagsToResource": "<p>Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a <code>Condition</code> statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.</p>",
@@ -143,6 +143,7 @@
143143
"EventSubscription$Enabled": "<p>A Boolean value indicating whether the subscription is enabled. A value of <code>true</code> indicates that the subscription is enabled.</p>",
144144
"GlobalClusterMember$IsWriter": "<p> Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated. </p>",
145145
"ModifyDBClusterMessage$ApplyImmediately": "<p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster. If this parameter is set to <code>false</code>, changes to the cluster are applied during the next maintenance window.</p> <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p> <p>Default: <code>false</code> </p>",
146+
"ModifyDBClusterMessage$AllowMajorVersionUpgrade": "<p>A value that indicates whether major version upgrades are allowed.</p> <p>Constraints: You must allow major version upgrades when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the DB cluster's current version.</p>",
146147
"ModifyDBInstanceMessage$ApplyImmediately": "<p>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the instance. </p> <p> If this parameter is set to <code>false</code>, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.</p> <p>Default: <code>false</code> </p>",
147148
"OrderableDBInstanceOption$Vpc": "<p>Indicates whether an instance is in a virtual private cloud (VPC).</p>",
148149
"Parameter$IsModifiable": "<p> Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. </p>",
@@ -1588,7 +1589,7 @@
15881589
"ModifyDBClusterMessage$MasterUserPassword": "<p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).</p> <p>Constraints: Must contain from 8 to 100 characters.</p>",
15891590
"ModifyDBClusterMessage$PreferredBackupWindow": "<p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>",
15901591
"ModifyDBClusterMessage$PreferredMaintenanceWindow": "<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. </p> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Minimum 30-minute window.</p>",
1591-
"ModifyDBClusterMessage$EngineVersion": "<p>The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.</p>",
1592+
"ModifyDBClusterMessage$EngineVersion": "<p>The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless <code>ApplyImmediately</code> is enabled.</p> <p>To list all of the available engine versions for Amazon DocumentDB use the following command:</p> <p> <code>aws docdb describe-db-engine-versions --engine docdb --query \"DBEngineVersions[].EngineVersion\"</code> </p>",
15921593
"ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName": "<p>The name of the cluster parameter group to modify.</p>",
15931594
"ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier": "<p>The identifier for the cluster snapshot to modify the attributes for.</p>",
15941595
"ModifyDBClusterSnapshotAttributeMessage$AttributeName": "<p>The name of the cluster snapshot attribute to modify.</p> <p>To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to <code>restore</code>.</p>",

generator/ServiceModels/docdb/docdb-2014-10-31.normal.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3745,7 +3745,11 @@
37453745
},
37463746
"EngineVersion":{
37473747
"shape":"String",
3748-
"documentation":"<p>The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.</p>"
3748+
"documentation":"<p>The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless <code>ApplyImmediately</code> is enabled.</p> <p>To list all of the available engine versions for Amazon DocumentDB use the following command:</p> <p> <code>aws docdb describe-db-engine-versions --engine docdb --query \"DBEngineVersions[].EngineVersion\"</code> </p>"
3749+
},
3750+
"AllowMajorVersionUpgrade":{
3751+
"shape":"Boolean",
3752+
"documentation":"<p>A value that indicates whether major version upgrades are allowed.</p> <p>Constraints: You must allow major version upgrades when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the DB cluster's current version.</p>"
37493753
},
37503754
"DeletionProtection":{
37513755
"shape":"BooleanOptional",
@@ -4790,5 +4794,5 @@
47904794
}
47914795
}
47924796
},
4793-
"documentation":"<p>Amazon DocumentDB API documentation</p>"
4797+
"documentation":"<p>Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.</p>"
47944798
}

sdk/src/Services/DocDB/Generated/Model/Internal/MarshallTransformations/ModifyDBClusterRequestMarshaller.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ public IRequest Marshall(ModifyDBClusterRequest publicRequest)
5858

5959
if(publicRequest != null)
6060
{
61+
if(publicRequest.IsSetAllowMajorVersionUpgrade())
62+
{
63+
request.Parameters.Add("AllowMajorVersionUpgrade", StringUtils.FromBool(publicRequest.AllowMajorVersionUpgrade));
64+
}
6165
if(publicRequest.IsSetApplyImmediately())
6266
{
6367
request.Parameters.Add("ApplyImmediately", StringUtils.FromBool(publicRequest.ApplyImmediately));

sdk/src/Services/DocDB/Generated/Model/ModifyDBClusterRequest.cs

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ namespace Amazon.DocDB.Model
3636
/// </summary>
3737
public partial class ModifyDBClusterRequest : AmazonDocDBRequest
3838
{
39+
private bool? _allowMajorVersionUpgrade;
3940
private bool? _applyImmediately;
4041
private int? _backupRetentionPeriod;
4142
private CloudwatchLogsExportConfiguration _cloudwatchLogsExportConfiguration;
@@ -50,6 +51,30 @@ public partial class ModifyDBClusterRequest : AmazonDocDBRequest
5051
private string _preferredMaintenanceWindow;
5152
private List<string> _vpcSecurityGroupIds = new List<string>();
5253

54+
/// <summary>
55+
/// Gets and sets the property AllowMajorVersionUpgrade.
56+
/// <para>
57+
/// A value that indicates whether major version upgrades are allowed.
58+
/// </para>
59+
///
60+
/// <para>
61+
/// Constraints: You must allow major version upgrades when specifying a value for the
62+
/// <code>EngineVersion</code> parameter that is a different major version than the DB
63+
/// cluster's current version.
64+
/// </para>
65+
/// </summary>
66+
public bool AllowMajorVersionUpgrade
67+
{
68+
get { return this._allowMajorVersionUpgrade.GetValueOrDefault(); }
69+
set { this._allowMajorVersionUpgrade = value; }
70+
}
71+
72+
// Check to see if AllowMajorVersionUpgrade property is set
73+
internal bool IsSetAllowMajorVersionUpgrade()
74+
{
75+
return this._allowMajorVersionUpgrade.HasValue;
76+
}
77+
5378
/// <summary>
5479
/// Gets and sets the property ApplyImmediately.
5580
/// <para>
@@ -206,8 +231,19 @@ internal bool IsSetDeletionProtection()
206231
/// <summary>
207232
/// Gets and sets the property EngineVersion.
208233
/// <para>
209-
/// The version number of the database engine to which you want to upgrade. Modifying
210-
/// engine version is not supported on Amazon DocumentDB.
234+
/// The version number of the database engine to which you want to upgrade. Changing this
235+
/// parameter results in an outage. The change is applied during the next maintenance
236+
/// window unless <code>ApplyImmediately</code> is enabled.
237+
/// </para>
238+
///
239+
/// <para>
240+
/// To list all of the available engine versions for Amazon DocumentDB use the following
241+
/// command:
242+
/// </para>
243+
///
244+
/// <para>
245+
/// <code>aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"</code>
246+
///
211247
/// </para>
212248
/// </summary>
213249
public string EngineVersion

sdk/src/Services/DocDB/Generated/_bcl35/AmazonDocDBClient.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ namespace Amazon.DocDB
3535
/// <summary>
3636
/// Implementation for accessing DocDB
3737
///
38-
/// Amazon DocumentDB API documentation
38+
/// Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon
39+
/// DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases
40+
/// in the cloud. With Amazon DocumentDB, you can run the same application code and use
41+
/// the same drivers and tools that you use with MongoDB.
3942
/// </summary>
4043
public partial class AmazonDocDBClient : AmazonServiceClient, IAmazonDocDB
4144
{

sdk/src/Services/DocDB/Generated/_bcl35/IAmazonDocDB.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ namespace Amazon.DocDB
2929
/// <summary>
3030
/// Interface for accessing DocDB
3131
///
32-
/// Amazon DocumentDB API documentation
32+
/// Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon
33+
/// DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases
34+
/// in the cloud. With Amazon DocumentDB, you can run the same application code and use
35+
/// the same drivers and tools that you use with MongoDB.
3336
/// </summary>
3437
public partial interface IAmazonDocDB : IAmazonService, IDisposable
3538
{

sdk/src/Services/DocDB/Generated/_bcl45/AmazonDocDBClient.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ namespace Amazon.DocDB
3838
/// <summary>
3939
/// Implementation for accessing DocDB
4040
///
41-
/// Amazon DocumentDB API documentation
41+
/// Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon
42+
/// DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases
43+
/// in the cloud. With Amazon DocumentDB, you can run the same application code and use
44+
/// the same drivers and tools that you use with MongoDB.
4245
/// </summary>
4346
public partial class AmazonDocDBClient : AmazonServiceClient, IAmazonDocDB
4447
{

sdk/src/Services/DocDB/Generated/_bcl45/IAmazonDocDB.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ namespace Amazon.DocDB
3131
/// <summary>
3232
/// Interface for accessing DocDB
3333
///
34-
/// Amazon DocumentDB API documentation
34+
/// Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon
35+
/// DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases
36+
/// in the cloud. With Amazon DocumentDB, you can run the same application code and use
37+
/// the same drivers and tools that you use with MongoDB.
3538
/// </summary>
3639
public partial interface IAmazonDocDB : IAmazonService, IDisposable
3740
{

sdk/src/Services/DocDB/Generated/_netstandard/AmazonDocDBClient.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ namespace Amazon.DocDB
3838
/// <summary>
3939
/// Implementation for accessing DocDB
4040
///
41-
/// Amazon DocumentDB API documentation
41+
/// Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon
42+
/// DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases
43+
/// in the cloud. With Amazon DocumentDB, you can run the same application code and use
44+
/// the same drivers and tools that you use with MongoDB.
4245
/// </summary>
4346
public partial class AmazonDocDBClient : AmazonServiceClient, IAmazonDocDB
4447
{

0 commit comments

Comments
 (0)