Skip to content

Commit

Permalink
feat(client-rds): This release adds support for Enhanced Monitoring a…
Browse files Browse the repository at this point in the history
…nd Performance Insights when restoring Aurora Limitless Database DB clusters. It also adds support for the os-upgrade pending maintenance action.
  • Loading branch information
awstools committed Oct 28, 2024
1 parent 13d1e18 commit 02407f8
Show file tree
Hide file tree
Showing 6 changed files with 294 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,11 @@ export interface RestoreDBClusterFromSnapshotCommandOutput
* TransitGatewayMulticastDomainId: "STRING_VALUE",
* ReplicaMode: "open-read-only" || "mounted",
* },
* MonitoringInterval: Number("int"),
* MonitoringRoleArn: "STRING_VALUE",
* EnablePerformanceInsights: true || false,
* PerformanceInsightsKMSKeyId: "STRING_VALUE",
* PerformanceInsightsRetentionPeriod: Number("int"),
* EngineLifecycleSupport: "STRING_VALUE",
* };
* const command = new RestoreDBClusterFromSnapshotCommand(input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,11 @@ export interface RestoreDBClusterToPointInTimeCommandOutput
* TransitGatewayMulticastDomainId: "STRING_VALUE",
* ReplicaMode: "open-read-only" || "mounted",
* },
* MonitoringInterval: Number("int"),
* MonitoringRoleArn: "STRING_VALUE",
* EnablePerformanceInsights: true || false,
* PerformanceInsightsKMSKeyId: "STRING_VALUE",
* PerformanceInsightsRetentionPeriod: Number("int"),
* EngineLifecycleSupport: "STRING_VALUE",
* };
* const command = new RestoreDBClusterToPointInTimeCommand(input);
Expand Down
70 changes: 65 additions & 5 deletions clients/client-rds/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -771,9 +771,37 @@ export interface ApplyPendingMaintenanceActionMessage {

/**
* <p>The pending maintenance action to apply to this resource.</p>
* <p>Valid Values: <code>system-update</code>, <code>db-upgrade</code>,
* <code>hardware-maintenance</code>, <code>ca-certificate-rotation</code>
* </p>
* <p>Valid Values:</p>
* <ul>
* <li>
* <p>
* <code>ca-certificate-rotation</code>
* </p>
* </li>
* <li>
* <p>
* <code>db-upgrade</code>
* </p>
* </li>
* <li>
* <p>
* <code>hardware-maintenance</code>
* </p>
* </li>
* <li>
* <p>
* <code>os-upgrade</code>
* </p>
* </li>
* <li>
* <p>
* <code>system-update</code>
* </p>
* </li>
* </ul>
* <p>For more information about these actions, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-aurora">Maintenance actions for Amazon Aurora</a> or
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-rds">Maintenance actions for Amazon RDS</a>.</p>
* @public
*/
ApplyAction: string | undefined;
Expand Down Expand Up @@ -811,8 +839,37 @@ export interface PendingMaintenanceAction {
/**
* <p>The type of pending maintenance action that is available for the resource. </p>
* <p>For more information about maintenance actions, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html">Maintaining a DB instance</a>.</p>
* <p>Valid Values:<code> system-update | db-upgrade | hardware-maintenance | ca-certificate-rotation</code>
* </p>
* <p>Valid Values:</p>
* <ul>
* <li>
* <p>
* <code>ca-certificate-rotation</code>
* </p>
* </li>
* <li>
* <p>
* <code>db-upgrade</code>
* </p>
* </li>
* <li>
* <p>
* <code>hardware-maintenance</code>
* </p>
* </li>
* <li>
* <p>
* <code>os-upgrade</code>
* </p>
* </li>
* <li>
* <p>
* <code>system-update</code>
* </p>
* </li>
* </ul>
* <p>For more information about these actions, see
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-aurora">Maintenance actions for Amazon Aurora</a> or
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#maintenance-actions-rds">Maintenance actions for Amazon RDS</a>.</p>
* @public
*/
Action?: string;
Expand Down Expand Up @@ -5153,6 +5210,9 @@ export interface CreateDBClusterMessage {
/**
* <p>Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.</p>
* <p>Valid for: Aurora DB clusters only</p>
* <note>
* <p>This setting is no longer used. Instead use the <code>ClusterScalabilityType</code> setting.</p>
* </note>
* @public
*/
EnableLimitlessDatabase?: boolean;
Expand Down
125 changes: 125 additions & 0 deletions clients/client-rds/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7994,6 +7994,9 @@ export interface ModifyDBClusterMessage {
/**
* <p>Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.</p>
* <p>Valid for: Aurora DB clusters only</p>
* <note>
* <p>This setting is no longer used. Instead use the <code>ClusterScalabilityType</code> setting when you create your Aurora Limitless Database DB cluster.</p>
* </note>
* @public
*/
EnableLimitlessDatabase?: boolean;
Expand Down Expand Up @@ -11879,6 +11882,67 @@ export interface RestoreDBClusterFromSnapshotMessage {
*/
RdsCustomClusterConfiguration?: RdsCustomClusterConfiguration;

/**
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off
* collecting Enhanced Monitoring metrics, specify <code>0</code>.</p>
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code> to a value other than <code>0</code>.</p>
* <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
* </p>
* <p>Default: <code>0</code>
* </p>
* @public
*/
MonitoringInterval?: number;

/**
* <p>The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
* An example is <code>arn:aws:iam:123456789012:role/emaccess</code>.</p>
* <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, supply a <code>MonitoringRoleArn</code> value.</p>
* @public
*/
MonitoringRoleArn?: string;

/**
* <p>Specifies whether to turn on Performance Insights for the DB cluster.</p>
* @public
*/
EnablePerformanceInsights?: boolean;

/**
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS uses your default KMS key.
* There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
* @public
*/
PerformanceInsightsKMSKeyId?: string;

/**
* <p>The number of days to retain Performance Insights data.</p>
* <p>Valid Values:</p>
* <ul>
* <li>
* <p>
* <code>7</code>
* </p>
* </li>
* <li>
* <p>
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23.
* Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p>
* </li>
* <li>
* <p>
* <code>731</code>
* </p>
* </li>
* </ul>
* <p>Default: <code>7</code> days</p>
* <p>If you specify a retention period that isn't valid, such as <code>94</code>, Amazon RDS issues an error.</p>
* @public
*/
PerformanceInsightsRetentionPeriod?: number;

/**
* <p>The life cycle type for this DB cluster.</p>
* <note>
Expand Down Expand Up @@ -12340,6 +12404,67 @@ export interface RestoreDBClusterToPointInTimeMessage {
*/
RdsCustomClusterConfiguration?: RdsCustomClusterConfiguration;

/**
* <p>The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off
* collecting Enhanced Monitoring metrics, specify <code>0</code>.</p>
* <p>If <code>MonitoringRoleArn</code> is specified, also set <code>MonitoringInterval</code> to a value other than <code>0</code>.</p>
* <p>Valid Values: <code>0 | 1 | 5 | 10 | 15 | 30 | 60</code>
* </p>
* <p>Default: <code>0</code>
* </p>
* @public
*/
MonitoringInterval?: number;

/**
* <p>The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
* An example is <code>arn:aws:iam:123456789012:role/emaccess</code>.</p>
* <p>If <code>MonitoringInterval</code> is set to a value other than <code>0</code>, supply a <code>MonitoringRoleArn</code> value.</p>
* @public
*/
MonitoringRoleArn?: string;

/**
* <p>Specifies whether to turn on Performance Insights for the DB cluster.</p>
* @public
*/
EnablePerformanceInsights?: boolean;

/**
* <p>The Amazon Web Services KMS key identifier for encryption of Performance Insights data.</p>
* <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
* <p>If you don't specify a value for <code>PerformanceInsightsKMSKeyId</code>, then Amazon RDS uses your default KMS key.
* There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.</p>
* @public
*/
PerformanceInsightsKMSKeyId?: string;

/**
* <p>The number of days to retain Performance Insights data.</p>
* <p>Valid Values:</p>
* <ul>
* <li>
* <p>
* <code>7</code>
* </p>
* </li>
* <li>
* <p>
* <i>month</i> * 31, where <i>month</i> is a number of months from 1-23.
* Examples: <code>93</code> (3 months * 31), <code>341</code> (11 months * 31), <code>589</code> (19 months * 31)</p>
* </li>
* <li>
* <p>
* <code>731</code>
* </p>
* </li>
* </ul>
* <p>Default: <code>7</code> days</p>
* <p>If you specify a retention period that isn't valid, such as <code>94</code>, Amazon RDS issues an error.</p>
* @public
*/
PerformanceInsightsRetentionPeriod?: number;

/**
* <p>The life cycle type for this DB cluster.</p>
* <note>
Expand Down
30 changes: 30 additions & 0 deletions clients/client-rds/src/protocols/Aws_query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15221,6 +15221,21 @@ const se_RestoreDBClusterFromSnapshotMessage = (
entries[loc] = value;
});
}
if (input[_MIo] != null) {
entries[_MIo] = input[_MIo];
}
if (input[_MRA] != null) {
entries[_MRA] = input[_MRA];
}
if (input[_EPI] != null) {
entries[_EPI] = input[_EPI];
}
if (input[_PIKMSKI] != null) {
entries[_PIKMSKI] = input[_PIKMSKI];
}
if (input[_PIRP] != null) {
entries[_PIRP] = input[_PIRP];
}
if (input[_ELS] != null) {
entries[_ELS] = input[_ELS];
}
Expand Down Expand Up @@ -15355,6 +15370,21 @@ const se_RestoreDBClusterToPointInTimeMessage = (
entries[loc] = value;
});
}
if (input[_MIo] != null) {
entries[_MIo] = input[_MIo];
}
if (input[_MRA] != null) {
entries[_MRA] = input[_MRA];
}
if (input[_EPI] != null) {
entries[_EPI] = input[_EPI];
}
if (input[_PIKMSKI] != null) {
entries[_PIKMSKI] = input[_PIKMSKI];
}
if (input[_PIRP] != null) {
entries[_PIRP] = input[_PIRP];
}
if (input[_ELS] != null) {
entries[_ELS] = input[_ELS];
}
Expand Down
Loading

0 comments on commit 02407f8

Please sign in to comment.