diff --git a/clients/client-rds/README.md b/clients/client-rds/README.md index 2aa753c6a3f9..8c6d8354fc3b 100644 --- a/clients/client-rds/README.md +++ b/clients/client-rds/README.md @@ -1391,6 +1391,14 @@ SwitchoverBlueGreenDeployment [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rds/classes/switchoverbluegreendeploymentcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rds/interfaces/switchoverbluegreendeploymentcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rds/interfaces/switchoverbluegreendeploymentcommandoutput.html) + +
+ +SwitchoverGlobalCluster + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rds/classes/switchoverglobalclustercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rds/interfaces/switchoverglobalclustercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rds/interfaces/switchoverglobalclustercommandoutput.html) +
diff --git a/clients/client-rds/src/RDS.ts b/clients/client-rds/src/RDS.ts index e75842aa558f..512ccc4cc354 100644 --- a/clients/client-rds/src/RDS.ts +++ b/clients/client-rds/src/RDS.ts @@ -712,6 +712,11 @@ import { SwitchoverBlueGreenDeploymentCommandInput, SwitchoverBlueGreenDeploymentCommandOutput, } from "./commands/SwitchoverBlueGreenDeploymentCommand"; +import { + SwitchoverGlobalClusterCommand, + SwitchoverGlobalClusterCommandInput, + SwitchoverGlobalClusterCommandOutput, +} from "./commands/SwitchoverGlobalClusterCommand"; import { SwitchoverReadReplicaCommand, SwitchoverReadReplicaCommandInput, @@ -862,6 +867,7 @@ const commands = { StopDBInstanceCommand, StopDBInstanceAutomatedBackupsReplicationCommand, SwitchoverBlueGreenDeploymentCommand, + SwitchoverGlobalClusterCommand, SwitchoverReadReplicaCommand, }; @@ -3223,6 +3229,23 @@ export interface RDS { cb: (err: any, data?: SwitchoverBlueGreenDeploymentCommandOutput) => void ): void; + /** + * @see {@link SwitchoverGlobalClusterCommand} + */ + switchoverGlobalCluster( + args: SwitchoverGlobalClusterCommandInput, + options?: __HttpHandlerOptions + ): Promise; + switchoverGlobalCluster( + args: SwitchoverGlobalClusterCommandInput, + cb: (err: any, data?: SwitchoverGlobalClusterCommandOutput) => void + ): void; + switchoverGlobalCluster( + args: SwitchoverGlobalClusterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: SwitchoverGlobalClusterCommandOutput) => void + ): void; + /** * @see {@link SwitchoverReadReplicaCommand} */ diff --git a/clients/client-rds/src/RDSClient.ts b/clients/client-rds/src/RDSClient.ts index de237d0b27e9..47cf12f5ea31 100644 --- a/clients/client-rds/src/RDSClient.ts +++ b/clients/client-rds/src/RDSClient.ts @@ -510,6 +510,10 @@ import { SwitchoverBlueGreenDeploymentCommandInput, SwitchoverBlueGreenDeploymentCommandOutput, } from "./commands/SwitchoverBlueGreenDeploymentCommand"; +import { + SwitchoverGlobalClusterCommandInput, + SwitchoverGlobalClusterCommandOutput, +} from "./commands/SwitchoverGlobalClusterCommand"; import { SwitchoverReadReplicaCommandInput, SwitchoverReadReplicaCommandOutput, @@ -671,6 +675,7 @@ export type ServiceInputTypes = | StopDBInstanceAutomatedBackupsReplicationCommandInput | StopDBInstanceCommandInput | SwitchoverBlueGreenDeploymentCommandInput + | SwitchoverGlobalClusterCommandInput | SwitchoverReadReplicaCommandInput; /** @@ -819,6 +824,7 @@ export type ServiceOutputTypes = | StopDBInstanceAutomatedBackupsReplicationCommandOutput | StopDBInstanceCommandOutput | SwitchoverBlueGreenDeploymentCommandOutput + | SwitchoverGlobalClusterCommandOutput | SwitchoverReadReplicaCommandOutput; /** diff --git a/clients/client-rds/src/commands/CreateGlobalClusterCommand.ts b/clients/client-rds/src/commands/CreateGlobalClusterCommand.ts index 9d7b42dd3b3d..227d09fcad3b 100644 --- a/clients/client-rds/src/commands/CreateGlobalClusterCommand.ts +++ b/clients/client-rds/src/commands/CreateGlobalClusterCommand.ts @@ -85,12 +85,14 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes * // ], * // IsWriter: true || false, * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", + * // SynchronizationStatus: "connected" || "pending-resync", * // }, * // ], * // FailoverState: { // FailoverState * // Status: "pending" || "failing-over" || "cancelling", * // FromDbClusterArn: "STRING_VALUE", * // ToDbClusterArn: "STRING_VALUE", + * // IsDataLossAllowed: true || false, * // }, * // }, * // }; diff --git a/clients/client-rds/src/commands/DeleteGlobalClusterCommand.ts b/clients/client-rds/src/commands/DeleteGlobalClusterCommand.ts index ea8d8b124354..03e3664a6b55 100644 --- a/clients/client-rds/src/commands/DeleteGlobalClusterCommand.ts +++ b/clients/client-rds/src/commands/DeleteGlobalClusterCommand.ts @@ -71,12 +71,14 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes * // ], * // IsWriter: true || false, * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", + * // SynchronizationStatus: "connected" || "pending-resync", * // }, * // ], * // FailoverState: { // FailoverState * // Status: "pending" || "failing-over" || "cancelling", * // FromDbClusterArn: "STRING_VALUE", * // ToDbClusterArn: "STRING_VALUE", + * // IsDataLossAllowed: true || false, * // }, * // }, * // }; diff --git a/clients/client-rds/src/commands/DescribeDBEngineVersionsCommand.ts b/clients/client-rds/src/commands/DescribeDBEngineVersionsCommand.ts index cc2ac425e772..2077211d0c13 100644 --- a/clients/client-rds/src/commands/DescribeDBEngineVersionsCommand.ts +++ b/clients/client-rds/src/commands/DescribeDBEngineVersionsCommand.ts @@ -13,7 +13,8 @@ import { SerdeContext as __SerdeContext, } from "@smithy/types"; -import { DBEngineVersionMessage, DescribeDBEngineVersionsMessage } from "../models/models_0"; +import { DBEngineVersionMessage } from "../models/models_0"; +import { DescribeDBEngineVersionsMessage } from "../models/models_1"; import { de_DescribeDBEngineVersionsCommand, se_DescribeDBEngineVersionsCommand } from "../protocols/Aws_query"; import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; diff --git a/clients/client-rds/src/commands/DescribeGlobalClustersCommand.ts b/clients/client-rds/src/commands/DescribeGlobalClustersCommand.ts index ad820cbf206a..ec6a2387b507 100644 --- a/clients/client-rds/src/commands/DescribeGlobalClustersCommand.ts +++ b/clients/client-rds/src/commands/DescribeGlobalClustersCommand.ts @@ -84,12 +84,14 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa * // ], * // IsWriter: true || false, * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", + * // SynchronizationStatus: "connected" || "pending-resync", * // }, * // ], * // FailoverState: { // FailoverState * // Status: "pending" || "failing-over" || "cancelling", * // FromDbClusterArn: "STRING_VALUE", * // ToDbClusterArn: "STRING_VALUE", + * // IsDataLossAllowed: true || false, * // }, * // }, * // ], diff --git a/clients/client-rds/src/commands/FailoverGlobalClusterCommand.ts b/clients/client-rds/src/commands/FailoverGlobalClusterCommand.ts index c03fb348ea16..1196bc1594ff 100644 --- a/clients/client-rds/src/commands/FailoverGlobalClusterCommand.ts +++ b/clients/client-rds/src/commands/FailoverGlobalClusterCommand.ts @@ -36,19 +36,42 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste /** * @public - *

Initiates the failover process for an Aurora global database (GlobalCluster).

- *

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be - * the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, - * the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected - * secondary DB cluster assumes full read/write capabilities for the Aurora global database.

- *

For more information about failing over an Amazon Aurora global database, see - * Managed planned failover for Amazon Aurora global - * databases in the Amazon Aurora User Guide.

+ *

Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."

* - *

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on - * healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to - * reconfigure your Aurora global database topology.

+ *

Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. + * To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.

* + *

How you use this operation depends on whether you are failing over or switching over your global database cluster:

+ *
    + *
  • + *

    Failing over - Specify the AllowDataLoss parameter and don't specify the Switchover parameter.

    + *
    • + *
  • + *

    Switching over - Specify the Switchover parameter or omit it, but don't specify the AllowDataLoss parameter.

    + *
    • + *
+ *

+ * About failing over and switching over + *

+ *

While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:

+ *
    + *
  • + *

    + * Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. + * Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. + * However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees + * that the data is in a transactionally consistent state.

    + *

    For more information about failing over an Amazon Aurora global database, see + * Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.

    + *
    • + *
  • + *

    + * Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to + * fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.

    + *

    For more information about switching over an Amazon Aurora global database, see + * Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.

    + *
    • + *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -58,6 +81,8 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste * const input = { // FailoverGlobalClusterMessage * GlobalClusterIdentifier: "STRING_VALUE", // required * TargetDbClusterIdentifier: "STRING_VALUE", // required + * AllowDataLoss: true || false, + * Switchover: true || false, * }; * const command = new FailoverGlobalClusterCommand(input); * const response = await client.send(command); @@ -80,12 +105,14 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste * // ], * // IsWriter: true || false, * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", + * // SynchronizationStatus: "connected" || "pending-resync", * // }, * // ], * // FailoverState: { // FailoverState * // Status: "pending" || "failing-over" || "cancelling", * // FromDbClusterArn: "STRING_VALUE", * // ToDbClusterArn: "STRING_VALUE", + * // IsDataLossAllowed: true || false, * // }, * // }, * // }; diff --git a/clients/client-rds/src/commands/ModifyGlobalClusterCommand.ts b/clients/client-rds/src/commands/ModifyGlobalClusterCommand.ts index cc837aa11b93..42ec1620925a 100644 --- a/clients/client-rds/src/commands/ModifyGlobalClusterCommand.ts +++ b/clients/client-rds/src/commands/ModifyGlobalClusterCommand.ts @@ -36,7 +36,7 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes /** * @public - *

Modifies a setting for an Amazon Aurora global cluster. You can change one or more database configuration + *

Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration * parameters by specifying these parameters and the new values in the request. For more information on * Amazon Aurora, see What is Amazon Aurora? in the * Amazon Aurora User Guide.

@@ -77,12 +77,14 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes * // ], * // IsWriter: true || false, * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", + * // SynchronizationStatus: "connected" || "pending-resync", * // }, * // ], * // FailoverState: { // FailoverState * // Status: "pending" || "failing-over" || "cancelling", * // FromDbClusterArn: "STRING_VALUE", * // ToDbClusterArn: "STRING_VALUE", + * // IsDataLossAllowed: true || false, * // }, * // }, * // }; diff --git a/clients/client-rds/src/commands/RemoveFromGlobalClusterCommand.ts b/clients/client-rds/src/commands/RemoveFromGlobalClusterCommand.ts index d3b8bce4fa1c..8389606c75ad 100644 --- a/clients/client-rds/src/commands/RemoveFromGlobalClusterCommand.ts +++ b/clients/client-rds/src/commands/RemoveFromGlobalClusterCommand.ts @@ -73,12 +73,14 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl * // ], * // IsWriter: true || false, * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", + * // SynchronizationStatus: "connected" || "pending-resync", * // }, * // ], * // FailoverState: { // FailoverState * // Status: "pending" || "failing-over" || "cancelling", * // FromDbClusterArn: "STRING_VALUE", * // ToDbClusterArn: "STRING_VALUE", + * // IsDataLossAllowed: true || false, * // }, * // }, * // }; diff --git a/clients/client-rds/src/commands/SwitchoverGlobalClusterCommand.ts b/clients/client-rds/src/commands/SwitchoverGlobalClusterCommand.ts new file mode 100644 index 000000000000..1bb216d8435a --- /dev/null +++ b/clients/client-rds/src/commands/SwitchoverGlobalClusterCommand.ts @@ -0,0 +1,193 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { SwitchoverGlobalClusterMessage, SwitchoverGlobalClusterResult } from "../models/models_1"; +import { de_SwitchoverGlobalClusterCommand, se_SwitchoverGlobalClusterCommand } from "../protocols/Aws_query"; +import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link SwitchoverGlobalClusterCommand}. + */ +export interface SwitchoverGlobalClusterCommandInput extends SwitchoverGlobalClusterMessage {} +/** + * @public + * + * The output of {@link SwitchoverGlobalClusterCommand}. + */ +export interface SwitchoverGlobalClusterCommandOutput extends SwitchoverGlobalClusterResult, __MetadataBearer {} + +/** + * @public + *

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. + * Switchover operations were previously called "managed planned failovers."

+ *

Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster + * to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary + * at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database + * is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about + * switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.

+ * + *

This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original + * primary after a global database failover.

+ * + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, SwitchoverGlobalClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, SwitchoverGlobalClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const input = { // SwitchoverGlobalClusterMessage + * GlobalClusterIdentifier: "STRING_VALUE", // required + * TargetDbClusterIdentifier: "STRING_VALUE", // required + * }; + * const command = new SwitchoverGlobalClusterCommand(input); + * const response = await client.send(command); + * // { // SwitchoverGlobalClusterResult + * // GlobalCluster: { // GlobalCluster + * // GlobalClusterIdentifier: "STRING_VALUE", + * // GlobalClusterResourceId: "STRING_VALUE", + * // GlobalClusterArn: "STRING_VALUE", + * // Status: "STRING_VALUE", + * // Engine: "STRING_VALUE", + * // EngineVersion: "STRING_VALUE", + * // DatabaseName: "STRING_VALUE", + * // StorageEncrypted: true || false, + * // DeletionProtection: true || false, + * // GlobalClusterMembers: [ // GlobalClusterMemberList + * // { // GlobalClusterMember + * // DBClusterArn: "STRING_VALUE", + * // Readers: [ // ReadersArnList + * // "STRING_VALUE", + * // ], + * // IsWriter: true || false, + * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown", + * // SynchronizationStatus: "connected" || "pending-resync", + * // }, + * // ], + * // FailoverState: { // FailoverState + * // Status: "pending" || "failing-over" || "cancelling", + * // FromDbClusterArn: "STRING_VALUE", + * // ToDbClusterArn: "STRING_VALUE", + * // IsDataLossAllowed: true || false, + * // }, + * // }, + * // }; + * + * ``` + * + * @param SwitchoverGlobalClusterCommandInput - {@link SwitchoverGlobalClusterCommandInput} + * @returns {@link SwitchoverGlobalClusterCommandOutput} + * @see {@link SwitchoverGlobalClusterCommandInput} for command's `input` shape. + * @see {@link SwitchoverGlobalClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. + * + * @throws {@link DBClusterNotFoundFault} (client fault) + *

+ * DBClusterIdentifier doesn't refer to an existing DB cluster.

+ * + * @throws {@link GlobalClusterNotFoundFault} (client fault) + *

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

+ * + * @throws {@link InvalidDBClusterStateFault} (client fault) + *

The requested operation can't be performed while the cluster is in this state.

+ * + * @throws {@link InvalidGlobalClusterStateFault} (client fault) + *

The global cluster is in an invalid state and can't perform the requested operation.

+ * + * @throws {@link RDSServiceException} + *

Base exception class for all service exceptions from RDS service.

+ * + */ +export class SwitchoverGlobalClusterCommand extends $Command< + SwitchoverGlobalClusterCommandInput, + SwitchoverGlobalClusterCommandOutput, + RDSClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: SwitchoverGlobalClusterCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: RDSClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + this.middlewareStack.use( + getEndpointPlugin(configuration, SwitchoverGlobalClusterCommand.getEndpointParameterInstructions()) + ); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "RDSClient"; + const commandName = "SwitchoverGlobalClusterCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: (_: any) => _, + outputFilterSensitiveLog: (_: any) => _, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + /** + * @internal + */ + private serialize(input: SwitchoverGlobalClusterCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return se_SwitchoverGlobalClusterCommand(input, context); + } + + /** + * @internal + */ + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return de_SwitchoverGlobalClusterCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-rds/src/commands/index.ts b/clients/client-rds/src/commands/index.ts index 37b37ff2ddcb..136280158e87 100644 --- a/clients/client-rds/src/commands/index.ts +++ b/clients/client-rds/src/commands/index.ts @@ -141,4 +141,5 @@ export * from "./StopDBClusterCommand"; export * from "./StopDBInstanceAutomatedBackupsReplicationCommand"; export * from "./StopDBInstanceCommand"; export * from "./SwitchoverBlueGreenDeploymentCommand"; +export * from "./SwitchoverGlobalClusterCommand"; export * from "./SwitchoverReadReplicaCommand"; diff --git a/clients/client-rds/src/models/models_0.ts b/clients/client-rds/src/models/models_0.ts index 0b47aa6ad4ec..d92cb7cb33ec 100644 --- a/clients/client-rds/src/models/models_0.ts +++ b/clients/client-rds/src/models/models_0.ts @@ -4728,6 +4728,10 @@ export interface CreateDBClusterMessage { *

* * + * + *

When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned + * in the response. The storage type isn't returned when you set it to aurora.

+ * */ StorageType?: string; @@ -11263,26 +11267,26 @@ export type FailoverStatus = (typeof FailoverStatus)[keyof typeof FailoverStatus /** * @public - *

Contains the state of scheduled or in-process failover operations on an - * Aurora global database (GlobalCluster). This Data type is empty unless a failover - * operation is scheduled or is currently underway on the Aurora global database.

+ *

Contains the state of scheduled or in-process operations on a + * global cluster (Aurora global database). This data type is empty unless a switchover + * or failover operation is scheduled or is in progress on the Aurora global database.

*/ export interface FailoverState { /** * @public - *

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

+ *

The current status of the global cluster. Possible values are as follows:

*
    *
  • - *

    pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The - * GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover - * process can start.

    + *

    pending – The service received a request to switch over or fail over the global cluster. The + * global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation + * starts.

    *
    • *
  • - *

    failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such - * as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

    + *

    failing-over – This status covers the range of Aurora internal operations that take place during the switchover or failover process, such + * as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.

    *
    • *
  • - *

    cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary + *

    cancelling – The request to switch over or fail over the global cluster was cancelled and the primary * Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

    *
    • *
@@ -11302,41 +11306,69 @@ export interface FailoverState { * with this state.

*/ ToDbClusterArn?: string; + + /** + * @public + *

Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. + * Otherwise, it's a switchover.

+ */ + IsDataLossAllowed?: boolean; } +/** + * @public + * @enum + */ +export const GlobalClusterMemberSynchronizationStatus = { + CONNECTED: "connected", + PENDING_RESYNC: "pending-resync", +} as const; + +/** + * @public + */ +export type GlobalClusterMemberSynchronizationStatus = + (typeof GlobalClusterMemberSynchronizationStatus)[keyof typeof GlobalClusterMemberSynchronizationStatus]; + /** * @public *

A data structure with information about any primary and - * secondary clusters associated with an Aurora global database.

+ * secondary clusters associated with a global cluster (Aurora global database).

*/ export interface GlobalClusterMember { /** * @public - *

The Amazon Resource Name (ARN) for each Aurora cluster.

+ *

The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

*/ DBClusterArn?: string; /** * @public *

The Amazon Resource Name (ARN) for each read-only secondary cluster - * associated with the Aurora global database.

+ * associated with the global cluster.

*/ Readers?: string[]; /** * @public - *

Specifies whether the Aurora cluster is the primary cluster - * (that is, has read-write capability) for the Aurora global - * database with which it is associated.

+ *

Specifies whether the Aurora DB cluster is the primary cluster + * (that is, has read-write capability) for the global + * cluster with which it is associated.

*/ IsWriter?: boolean; /** * @public - *

Specifies whether a secondary cluster in an Aurora global database has + *

Specifies whether a secondary cluster in the global cluster has * write forwarding enabled, not enabled, or is in the process of enabling it.

*/ GlobalWriteForwardingStatus?: WriteForwardingStatus | string; + + /** + * @public + *

The status of synchronization of each Aurora DB cluster in the global cluster.

+ */ + SynchronizationStatus?: GlobalClusterMemberSynchronizationStatus | string; } /** @@ -11408,8 +11440,8 @@ export interface GlobalCluster { /** * @public - *

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. - * This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

+ *

A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). + * This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

*/ FailoverState?: FailoverState; } @@ -14097,239 +14129,3 @@ export interface DBEngineVersionMessage { */ DBEngineVersions?: DBEngineVersion[]; } - -/** - * @public - */ -export interface DescribeDBEngineVersionsMessage { - /** - * @public - *

The database engine to return.

- *

Valid Values:

- *
    - *
  • - *

    - * aurora-mysql - *

    - *
    • - *
  • - *

    - * aurora-postgresql - *

    - *
    • - *
  • - *

    - * custom-oracle-ee - *

    - *
    • - *
  • - *

    - * mariadb - *

    - *
    • - *
  • - *

    - * mysql - *

    - *
    • - *
  • - *

    - * oracle-ee - *

    - *
    • - *
  • - *

    - * oracle-ee-cdb - *

    - *
    • - *
  • - *

    - * oracle-se2 - *

    - *
    • - *
  • - *

    - * oracle-se2-cdb - *

    - *
    • - *
  • - *

    - * postgres - *

    - *
    • - *
  • - *

    - * sqlserver-ee - *

    - *
    • - *
  • - *

    - * sqlserver-se - *

    - *
    • - *
  • - *

    - * sqlserver-ex - *

    - *
    • - *
  • - *

    - * sqlserver-web - *

    - *
    • - *
- */ - Engine?: string; - - /** - * @public - *

The database engine version to return.

- *

Example: 5.1.49 - *

- */ - EngineVersion?: string; - - /** - * @public - *

The name of a specific DB parameter group family to return details for.

- *

Constraints:

- *
    - *
  • - *

    If supplied, must match an existing DBParameterGroupFamily.

    - *
    • - *
- */ - DBParameterGroupFamily?: string; - - /** - * @public - *

A filter that specifies one or more DB engine versions to describe.

- *

Supported filters:

- *
    - *
  • - *

    - * db-parameter-group-family - Accepts parameter groups family names. - * The results list only includes information about - * the DB engine versions for these parameter group families.

    - *
    • - *
  • - *

    - * engine - Accepts engine names. - * The results list only includes information about - * the DB engine versions for these engines.

    - *
    • - *
  • - *

    - * engine-mode - Accepts DB engine modes. - * The results list only includes information about - * the DB engine versions for these engine modes. Valid - * DB engine modes are the following:

    - *
      - *
    • - *

      - * global - *

      - *
      • - *
    • - *

      - * multimaster - *

      - *
      • - *
    • - *

      - * parallelquery - *

      - *
      • - *
    • - *

      - * provisioned - *

      - *
      • - *
    • - *

      - * serverless - *

      - *
      • - *
    - *
    • - *
  • - *

    - * engine-version - Accepts engine versions. - * The results list only includes information about - * the DB engine versions for these engine versions.

    - *
    • - *
  • - *

    - * status - Accepts engine version statuses. - * The results list only includes information about - * the DB engine versions for these statuses. Valid statuses - * are the following:

    - *
      - *
    • - *

      - * available - *

      - *
      • - *
    • - *

      - * deprecated - *

      - *
      • - *
    - *
    • - *
- */ - Filters?: Filter[]; - - /** - * @public - *

The maximum number of records to include in the response. - * If more than the MaxRecords value is available, a pagination token called a marker is - * included in the response so you can retrieve the remaining results.

- *

Default: 100

- *

Constraints: Minimum 20, maximum 100.

- */ - MaxRecords?: number; - - /** - * @public - *

An optional pagination token provided by a previous request. - * If this parameter is specified, the response includes - * only records beyond the marker, - * up to the value specified by MaxRecords.

- */ - Marker?: string; - - /** - * @public - *

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

- */ - DefaultOnly?: boolean; - - /** - * @public - *

A value that indicates whether to list the supported character sets for each engine version.

- *

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for - * CreateDBInstance, the response includes a list of supported character sets for each engine - * version.

- *

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets - * to true, RDS Custom returns no results.

- */ - ListSupportedCharacterSets?: boolean; - - /** - * @public - *

A value that indicates whether to list the supported time zones for each engine version.

- *

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, - * the response includes a list of supported time zones for each engine version.

- *

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones - * to true, RDS Custom returns no results.

- */ - ListSupportedTimezones?: boolean; - - /** - * @public - *

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

- */ - IncludeAll?: boolean; -} diff --git a/clients/client-rds/src/models/models_1.ts b/clients/client-rds/src/models/models_1.ts index 26f044fdbeae..f237cabe08ea 100644 --- a/clients/client-rds/src/models/models_1.ts +++ b/clients/client-rds/src/models/models_1.ts @@ -37,6 +37,242 @@ import { } from "./models_0"; import { RDSServiceException as __BaseException } from "./RDSServiceException"; +/** + * @public + */ +export interface DescribeDBEngineVersionsMessage { + /** + * @public + *

The database engine to return.

+ *

Valid Values:

+ *
    + *
  • + *

    + * aurora-mysql + *

    + *
    • + *
  • + *

    + * aurora-postgresql + *

    + *
    • + *
  • + *

    + * custom-oracle-ee + *

    + *
    • + *
  • + *

    + * mariadb + *

    + *
    • + *
  • + *

    + * mysql + *

    + *
    • + *
  • + *

    + * oracle-ee + *

    + *
    • + *
  • + *

    + * oracle-ee-cdb + *

    + *
    • + *
  • + *

    + * oracle-se2 + *

    + *
    • + *
  • + *

    + * oracle-se2-cdb + *

    + *
    • + *
  • + *

    + * postgres + *

    + *
    • + *
  • + *

    + * sqlserver-ee + *

    + *
    • + *
  • + *

    + * sqlserver-se + *

    + *
    • + *
  • + *

    + * sqlserver-ex + *

    + *
    • + *
  • + *

    + * sqlserver-web + *

    + *
    • + *
+ */ + Engine?: string; + + /** + * @public + *

The database engine version to return.

+ *

Example: 5.1.49 + *

+ */ + EngineVersion?: string; + + /** + * @public + *

The name of a specific DB parameter group family to return details for.

+ *

Constraints:

+ *
    + *
  • + *

    If supplied, must match an existing DBParameterGroupFamily.

    + *
    • + *
+ */ + DBParameterGroupFamily?: string; + + /** + * @public + *

A filter that specifies one or more DB engine versions to describe.

+ *

Supported filters:

+ *
    + *
  • + *

    + * db-parameter-group-family - Accepts parameter groups family names. + * The results list only includes information about + * the DB engine versions for these parameter group families.

    + *
    • + *
  • + *

    + * engine - Accepts engine names. + * The results list only includes information about + * the DB engine versions for these engines.

    + *
    • + *
  • + *

    + * engine-mode - Accepts DB engine modes. + * The results list only includes information about + * the DB engine versions for these engine modes. Valid + * DB engine modes are the following:

    + *
      + *
    • + *

      + * global + *

      + *
      • + *
    • + *

      + * multimaster + *

      + *
      • + *
    • + *

      + * parallelquery + *

      + *
      • + *
    • + *

      + * provisioned + *

      + *
      • + *
    • + *

      + * serverless + *

      + *
      • + *
    + *
    • + *
  • + *

    + * engine-version - Accepts engine versions. + * The results list only includes information about + * the DB engine versions for these engine versions.

    + *
    • + *
  • + *

    + * status - Accepts engine version statuses. + * The results list only includes information about + * the DB engine versions for these statuses. Valid statuses + * are the following:

    + *
      + *
    • + *

      + * available + *

      + *
      • + *
    • + *

      + * deprecated + *

      + *
      • + *
    + *
    • + *
+ */ + Filters?: Filter[]; + + /** + * @public + *

The maximum number of records to include in the response. + * If more than the MaxRecords value is available, a pagination token called a marker is + * included in the response so you can retrieve the remaining results.

+ *

Default: 100

+ *

Constraints: Minimum 20, maximum 100.

+ */ + MaxRecords?: number; + + /** + * @public + *

An optional pagination token provided by a previous request. + * If this parameter is specified, the response includes + * only records beyond the marker, + * up to the value specified by MaxRecords.

+ */ + Marker?: string; + + /** + * @public + *

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

+ */ + DefaultOnly?: boolean; + + /** + * @public + *

A value that indicates whether to list the supported character sets for each engine version.

+ *

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for + * CreateDBInstance, the response includes a list of supported character sets for each engine + * version.

+ *

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets + * to true, RDS Custom returns no results.

+ */ + ListSupportedCharacterSets?: boolean; + + /** + * @public + *

A value that indicates whether to list the supported time zones for each engine version.

+ *

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, + * the response includes a list of supported time zones for each engine version.

+ *

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones + * to true, RDS Custom returns no results.

+ */ + ListSupportedTimezones?: boolean; + + /** + * @public + *

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

+ */ + IncludeAll?: boolean; +} + /** * @public *

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

@@ -4002,15 +4238,13 @@ export interface FailoverDBClusterResult { export interface FailoverGlobalClusterMessage { /** * @public - *

Identifier of the Aurora global database (GlobalCluster) - * that should be failed over. The identifier is the unique key assigned by - * the user when the Aurora global database was created. In other words, - * it's the name of the Aurora global database that you want to fail over.

+ *

The identifier of the global database cluster (Aurora global database) this operation should apply to. + * The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, + * it's the name of the Aurora global database.

*

Constraints:

*
    *
  • - *

    Must match the identifier of an existing - * GlobalCluster (Aurora global database).

    + *

    Must match the identifier of an existing global database cluster.

    *
    • *
*/ @@ -4018,11 +4252,35 @@ export interface FailoverGlobalClusterMessage { /** * @public - *

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora - * global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that + *

The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that * Aurora can locate the cluster in its Amazon Web Services Region.

*/ TargetDbClusterIdentifier: string | undefined; + + /** + * @public + *

Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

+ *

If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.

+ *

Constraints:

+ *
    + *
  • + *

    Can't be specified together with the Switchover parameter.

    + *
    • + *
+ */ + AllowDataLoss?: boolean; + + /** + * @public + *

Specifies whether to switch over this global database cluster.

+ *

Constraints:

+ *
    + *
  • + *

    Can't be specified together with the AllowDataLoss parameter.

    + *
    • + *
+ */ + Switchover?: boolean; } /** @@ -11394,6 +11652,41 @@ export interface SwitchoverBlueGreenDeploymentResponse { BlueGreenDeployment?: BlueGreenDeployment; } +/** + * @public + */ +export interface SwitchoverGlobalClusterMessage { + /** + * @public + *

The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.

+ *

Constraints:

+ *
    + *
  • + *

    Must match the identifier of an existing global database cluster (Aurora global database).

    + *
    • + *
+ */ + GlobalClusterIdentifier: string | undefined; + + /** + * @public + *

The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that + * Aurora can locate the cluster in its Amazon Web Services Region.

+ */ + TargetDbClusterIdentifier: string | undefined; +} + +/** + * @public + */ +export interface SwitchoverGlobalClusterResult { + /** + * @public + *

A data type representing an Aurora global database.

+ */ + GlobalCluster?: GlobalCluster; +} + /** * @public */ diff --git a/clients/client-rds/src/protocols/Aws_query.ts b/clients/client-rds/src/protocols/Aws_query.ts index fa7cb41cba9b..3c1a7b2df281 100644 --- a/clients/client-rds/src/protocols/Aws_query.ts +++ b/clients/client-rds/src/protocols/Aws_query.ts @@ -484,6 +484,10 @@ import { SwitchoverBlueGreenDeploymentCommandInput, SwitchoverBlueGreenDeploymentCommandOutput, } from "../commands/SwitchoverBlueGreenDeploymentCommand"; +import { + SwitchoverGlobalClusterCommandInput, + SwitchoverGlobalClusterCommandOutput, +} from "../commands/SwitchoverGlobalClusterCommand"; import { SwitchoverReadReplicaCommandInput, SwitchoverReadReplicaCommandOutput, @@ -685,7 +689,6 @@ import { DescribeDBClusterSnapshotAttributesMessage, DescribeDBClusterSnapshotAttributesResult, DescribeDBClusterSnapshotsMessage, - DescribeDBEngineVersionsMessage, DomainMembership, DomainNotFoundFault, Ec2ImagePropertiesNotSupportedFault, @@ -797,6 +800,7 @@ import { DBSnapshotMessage, DBSubnetGroupMessage, DBUpgradeDependencyFailureFault, + DescribeDBEngineVersionsMessage, DescribeDBInstanceAutomatedBackupsMessage, DescribeDBInstancesMessage, DescribeDBLogFilesDetails, @@ -974,6 +978,8 @@ import { SubnetAlreadyInUse, SwitchoverBlueGreenDeploymentRequest, SwitchoverBlueGreenDeploymentResponse, + SwitchoverGlobalClusterMessage, + SwitchoverGlobalClusterResult, SwitchoverReadReplicaMessage, SwitchoverReadReplicaResult, TagListMessage, @@ -3397,6 +3403,23 @@ export const se_SwitchoverBlueGreenDeploymentCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_querySwitchoverGlobalClusterCommand + */ +export const se_SwitchoverGlobalClusterCommand = async ( + input: SwitchoverGlobalClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = SHARED_HEADERS; + let body: any; + body = buildFormUrlencodedString({ + ...se_SwitchoverGlobalClusterMessage(input, context), + Action: "SwitchoverGlobalCluster", + Version: "2014-10-31", + }); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_querySwitchoverReadReplicaCommand */ @@ -11197,6 +11220,61 @@ const de_SwitchoverBlueGreenDeploymentCommandError = async ( } }; +/** + * deserializeAws_querySwitchoverGlobalClusterCommand + */ +export const de_SwitchoverGlobalClusterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_SwitchoverGlobalClusterCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_SwitchoverGlobalClusterResult(data.SwitchoverGlobalClusterResult, context); + const response: SwitchoverGlobalClusterCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + +/** + * deserializeAws_querySwitchoverGlobalClusterCommandError + */ +const de_SwitchoverGlobalClusterCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseErrorBody(output.body, context), + }; + const errorCode = loadQueryErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "DBClusterNotFoundFault": + case "com.amazonaws.rds#DBClusterNotFoundFault": + throw await de_DBClusterNotFoundFaultRes(parsedOutput, context); + case "GlobalClusterNotFoundFault": + case "com.amazonaws.rds#GlobalClusterNotFoundFault": + throw await de_GlobalClusterNotFoundFaultRes(parsedOutput, context); + case "InvalidDBClusterStateFault": + case "com.amazonaws.rds#InvalidDBClusterStateFault": + throw await de_InvalidDBClusterStateFaultRes(parsedOutput, context); + case "InvalidGlobalClusterStateFault": + case "com.amazonaws.rds#InvalidGlobalClusterStateFault": + throw await de_InvalidGlobalClusterStateFaultRes(parsedOutput, context); + default: + const parsedBody = parsedOutput.body; + return throwDefaultError({ + output, + parsedBody: parsedBody.Error, + errorCode, + }); + } +}; + /** * deserializeAws_querySwitchoverReadReplicaCommand */ @@ -16411,6 +16489,12 @@ const se_FailoverGlobalClusterMessage = (input: FailoverGlobalClusterMessage, co if (input.TargetDbClusterIdentifier != null) { entries["TargetDbClusterIdentifier"] = input.TargetDbClusterIdentifier; } + if (input.AllowDataLoss != null) { + entries["AllowDataLoss"] = input.AllowDataLoss; + } + if (input.Switchover != null) { + entries["Switchover"] = input.Switchover; + } return entries; }; @@ -19045,6 +19129,20 @@ const se_SwitchoverBlueGreenDeploymentRequest = ( return entries; }; +/** + * serializeAws_querySwitchoverGlobalClusterMessage + */ +const se_SwitchoverGlobalClusterMessage = (input: SwitchoverGlobalClusterMessage, context: __SerdeContext): any => { + const entries: any = {}; + if (input.GlobalClusterIdentifier != null) { + entries["GlobalClusterIdentifier"] = input.GlobalClusterIdentifier; + } + if (input.TargetDbClusterIdentifier != null) { + entries["TargetDbClusterIdentifier"] = input.TargetDbClusterIdentifier; + } + return entries; +}; + /** * serializeAws_querySwitchoverReadReplicaMessage */ @@ -23864,6 +23962,9 @@ const de_FailoverState = (output: any, context: __SerdeContext): FailoverState = if (output["ToDbClusterArn"] !== undefined) { contents.ToDbClusterArn = __expectString(output["ToDbClusterArn"]); } + if (output["IsDataLossAllowed"] !== undefined) { + contents.IsDataLossAllowed = __parseBoolean(output["IsDataLossAllowed"]); + } return contents; }; @@ -23968,6 +24069,9 @@ const de_GlobalClusterMember = (output: any, context: __SerdeContext): GlobalClu if (output["GlobalWriteForwardingStatus"] !== undefined) { contents.GlobalWriteForwardingStatus = __expectString(output["GlobalWriteForwardingStatus"]); } + if (output["SynchronizationStatus"] !== undefined) { + contents.SynchronizationStatus = __expectString(output["SynchronizationStatus"]); + } return contents; }; @@ -26728,6 +26832,17 @@ const de_SwitchoverDetailList = (output: any, context: __SerdeContext): Switchov }); }; +/** + * deserializeAws_querySwitchoverGlobalClusterResult + */ +const de_SwitchoverGlobalClusterResult = (output: any, context: __SerdeContext): SwitchoverGlobalClusterResult => { + const contents: any = {}; + if (output["GlobalCluster"] !== undefined) { + contents.GlobalCluster = de_GlobalCluster(output["GlobalCluster"], context); + } + return contents; +}; + /** * deserializeAws_querySwitchoverReadReplicaResult */ diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 075663b36b76..de844fb64230 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -1,27944 +1,27888 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.rds#AccountAttributesMessage": { + "type": "structure", + "members": { + "AccountQuotas": { + "target": "com.amazonaws.rds#AccountQuotaList", + "traits": { + "smithy.api#documentation": "

A list of AccountQuota objects. Within this list, each quota has a name, \n a count of usage toward the quota maximum, and a maximum value for the quota.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeAccountAttributes action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#AccountQuota": { + "type": "structure", + "members": { + "AccountQuotaName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon RDS quota for this Amazon Web Services account.

" + } + }, + "Used": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount currently used toward the quota maximum.

" + } + }, + "Max": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum allowed value for the quota.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account.

\n

The following are account quotas:

\n
    \n
  • \n

    \n AllocatedStorage - The total allocated storage per account, in GiB.\n The used value is the total allocated storage in the account, in GiB.

    \n
    • \n
  • \n

    \n AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. \n The used value is the highest number of ingress rules in a DB security group in the account. Other \n DB security groups in the account might have a lower number of ingress rules.

    \n
    • \n
  • \n

    \n CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. \n The used value is the highest number of custom endpoints in a DB clusters in the account. Other \n DB clusters in the account might have a lower number of custom endpoints.

    \n
    • \n
  • \n

    \n DBClusterParameterGroups - The number of DB cluster parameter groups\n per account, excluding default parameter groups. The used value is the count of\n nondefault DB cluster parameter groups in the account.

    \n
    • \n
  • \n

    \n DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. \n The used value is the highest number of associated IAM roles for a DB cluster in the account. Other \n DB clusters in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBClusters - The number of DB clusters per account. \n The used value is the count of DB clusters in the account.

    \n
    • \n
  • \n

    \n DBInstanceRoles - The number of associated IAM roles per DB instance. \n The used value is the highest number of associated IAM roles for a DB instance in the account. Other \n DB instances in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBInstances - The number of DB instances per account. \n The used value is the count of the DB instances in the account.

    \n

    Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB \n instances apply to this quota.

    \n
    • \n
  • \n

    \n DBParameterGroups - The number of DB parameter groups per account,\n excluding default parameter groups. The used value is the count of nondefault DB\n parameter groups in the account.

    \n
    • \n
  • \n

    \n DBSecurityGroups - The number of DB security groups (not VPC\n security groups) per account, excluding the default security group. The used\n value is the count of nondefault DB security groups in the account.

    \n
    • \n
  • \n

    \n DBSubnetGroups - The number of DB subnet groups per account. \n The used value is the count of the DB subnet groups in the account.

    \n
    • \n
  • \n

    \n EventSubscriptions - The number of event subscriptions per account. \n The used value is the count of the event subscriptions in the account.

    \n
    • \n
  • \n

    \n ManualClusterSnapshots - The number of manual DB cluster snapshots per account. \n The used value is the count of the manual DB cluster snapshots in the account.

    \n
    • \n
  • \n

    \n ManualSnapshots - The number of manual DB instance snapshots per account. \n The used value is the count of the manual DB instance snapshots in the account.

    \n
    • \n
  • \n

    \n OptionGroups - The number of DB option groups per account, excluding\n default option groups. The used value is the count of nondefault DB option\n groups in the account.

    \n
    • \n
  • \n

    \n ReadReplicasPerMaster - The number of read replicas per DB\n instance. The used value is the highest number of read replicas for a DB\n instance in the account. Other DB instances in the account might have a lower\n number of read replicas.

    \n
    • \n
  • \n

    \n ReservedDBInstances - The number of reserved DB instances per account. \n The used value is the count of the active reserved DB instances in the account.

    \n
    • \n
  • \n

    \n SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. \n The used value is highest number of subnets for a DB subnet group in the account. Other \n DB subnet groups in the account might have a lower number of subnets.

    \n
    • \n
\n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#AccountQuotaList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AccountQuota", + "traits": { + "smithy.api#xmlName": "AccountQuota" + } + } + }, + "com.amazonaws.rds#ActivityStreamMode": { + "type": "enum", + "members": { + "sync": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sync" + } + }, + "async": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "async" + } + } + } + }, + "com.amazonaws.rds#ActivityStreamModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#ActivityStreamPolicyStatus": { + "type": "enum", + "members": { + "locked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locked" + } + }, + "unlocked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocked" + } + }, + "locking_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locking-policy" + } + }, + "unlocking_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocking-policy" + } + } + } + }, + "com.amazonaws.rds#ActivityStreamStatus": { + "type": "enum", + "members": { + "stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "starting" + } + }, + "started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "started" + } + }, + "stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + } + } + }, + "com.amazonaws.rds#AddRoleToDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddRoleToDBClusterMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with a DB cluster.

", + "smithy.api#examples": [ + { + "title": "To associate an AWS Identity and Access Management (IAM) role with a DB cluster", + "documentation": "The following example associates a role with a DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" } + } ] + } }, - "shapes": { - "com.amazonaws.rds#AccountAttributesMessage": { - "type": "structure", - "members": { - "AccountQuotas": { - "target": "com.amazonaws.rds#AccountQuotaList", - "traits": { - "smithy.api#documentation": "

A list of AccountQuota objects. Within this list, each quota has a name, \n a count of usage toward the quota maximum, and a maximum value for the quota.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned by the DescribeAccountAttributes action.

", - "smithy.api#output": {} + "com.amazonaws.rds#AddRoleToDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster to associate the IAM role with.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB\n cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AddRoleToDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddRoleToDBInstanceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n \n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To associate an AWS Identity and Access Management (IAM) role with a DB instance", + "documentation": "The following example adds the role to a DB instance named test-instance.", + "input": { + "DBInstanceIdentifier": "test-instance", + "RoleArn": "arn:aws:iam::111122223333:role/rds-s3-integration-role", + "FeatureName": "S3_INTEGRATION" } - }, - "com.amazonaws.rds#AccountQuota": { - "type": "structure", - "members": { - "AccountQuotaName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon RDS quota for this Amazon Web Services account.

" - } - }, - "Used": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount currently used toward the quota maximum.

" - } - }, - "Max": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum allowed value for the quota.

" - } - } + } + ] + } + }, + "com.amazonaws.rds#AddRoleToDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB instance to associate the IAM role with.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AddSourceIdentifierToSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a source identifier to an existing RDS event notification subscription.

", + "smithy.api#examples": [ + { + "title": "To add a source identifier to a subscription", + "documentation": "The following example adds another source identifier to an existing subscription.", + "input": { + "SubscriptionName": "my-instance-events", + "SourceIdentifier": "test-instance-repl" }, - "traits": { - "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account.

\n

The following are account quotas:

\n
    \n
  • \n

    \n AllocatedStorage - The total allocated storage per account, in GiB.\n The used value is the total allocated storage in the account, in GiB.

    \n
    • \n
  • \n

    \n AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. \n The used value is the highest number of ingress rules in a DB security group in the account. Other \n DB security groups in the account might have a lower number of ingress rules.

    \n
    • \n
  • \n

    \n CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. \n The used value is the highest number of custom endpoints in a DB clusters in the account. Other \n DB clusters in the account might have a lower number of custom endpoints.

    \n
    • \n
  • \n

    \n DBClusterParameterGroups - The number of DB cluster parameter groups\n per account, excluding default parameter groups. The used value is the count of\n nondefault DB cluster parameter groups in the account.

    \n
    • \n
  • \n

    \n DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. \n The used value is the highest number of associated IAM roles for a DB cluster in the account. Other \n DB clusters in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBClusters - The number of DB clusters per account. \n The used value is the count of DB clusters in the account.

    \n
    • \n
  • \n

    \n DBInstanceRoles - The number of associated IAM roles per DB instance. \n The used value is the highest number of associated IAM roles for a DB instance in the account. Other \n DB instances in the account might have a lower number of associated IAM roles.

    \n
    • \n
  • \n

    \n DBInstances - The number of DB instances per account. \n The used value is the count of the DB instances in the account.

    \n

    Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB \n instances apply to this quota.

    \n
    • \n
  • \n

    \n DBParameterGroups - The number of DB parameter groups per account,\n excluding default parameter groups. The used value is the count of nondefault DB\n parameter groups in the account.

    \n
    • \n
  • \n

    \n DBSecurityGroups - The number of DB security groups (not VPC\n security groups) per account, excluding the default security group. The used\n value is the count of nondefault DB security groups in the account.

    \n
    • \n
  • \n

    \n DBSubnetGroups - The number of DB subnet groups per account. \n The used value is the count of the DB subnet groups in the account.

    \n
    • \n
  • \n

    \n EventSubscriptions - The number of event subscriptions per account. \n The used value is the count of the event subscriptions in the account.

    \n
    • \n
  • \n

    \n ManualClusterSnapshots - The number of manual DB cluster snapshots per account. \n The used value is the count of the manual DB cluster snapshots in the account.

    \n
    • \n
  • \n

    \n ManualSnapshots - The number of manual DB instance snapshots per account. \n The used value is the count of the manual DB instance snapshots in the account.

    \n
    • \n
  • \n

    \n OptionGroups - The number of DB option groups per account, excluding\n default option groups. The used value is the count of nondefault DB option\n groups in the account.

    \n
    • \n
  • \n

    \n ReadReplicasPerMaster - The number of read replicas per DB\n instance. The used value is the highest number of read replicas for a DB\n instance in the account. Other DB instances in the account might have a lower\n number of read replicas.

    \n
    • \n
  • \n

    \n ReservedDBInstances - The number of reserved DB instances per account. \n The used value is the count of the active reserved DB instances in the account.

    \n
    • \n
  • \n

    \n SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. \n The used value is highest number of subnets for a DB subnet group in the account. Other \n DB subnet groups in the account might have a lower number of subnets.

    \n
    • \n
\n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#AccountQuotaList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#AccountQuota", - "traits": { - "smithy.api#xmlName": "AccountQuota" + "output": { + "EventSubscription": { + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "CustSubscriptionId": "my-instance-events", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Enabled": false, + "Status": "modifying", + "EventCategoriesList": ["backup", "recovery"], + "CustomerAwsId": "123456789012", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "SourceIdsList": ["test-instance", "test-instance-repl"] + } + } + } + ] + } + }, + "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to add a source identifier to.

", + "smithy.api#required": {} + } + }, + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source to be added.

\n

Constraints:

\n
    \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#AddTagsToResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddTagsToResourceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

", + "smithy.api#examples": [ + { + "title": "To add tags to a resource", + "documentation": "This example adds a tag to an option group.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup", + "Tags": [ + { + "Key": "Staging", + "Value": "LocationDB" } + ] } + } + ] + } + }, + "com.amazonaws.rds#AddTagsToResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AmazonRDSv19": { + "type": "service", + "version": "2014-10-31", + "operations": [ + { + "target": "com.amazonaws.rds#AddRoleToDBCluster" }, - "com.amazonaws.rds#ActivityStreamMode": { - "type": "enum", - "members": { - "sync": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sync" - } - }, - "async": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "async" - } - } - } + { + "target": "com.amazonaws.rds#AddRoleToDBInstance" }, - "com.amazonaws.rds#ActivityStreamModeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } + { + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscription" }, - "com.amazonaws.rds#ActivityStreamPolicyStatus": { - "type": "enum", - "members": { - "locked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "locked" - } - }, - "unlocked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unlocked" - } - }, - "locking_policy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "locking-policy" - } - }, - "unlocking_policy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unlocking-policy" - } - } - } + { + "target": "com.amazonaws.rds#AddTagsToResource" }, - "com.amazonaws.rds#ActivityStreamStatus": { - "type": "enum", - "members": { - "stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopped" - } - }, - "starting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "starting" - } - }, - "started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "started" - } - }, - "stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopping" + { + "target": "com.amazonaws.rds#ApplyPendingMaintenanceAction" + }, + { + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress" + }, + { + "target": "com.amazonaws.rds#BacktrackDBCluster" + }, + { + "target": "com.amazonaws.rds#CancelExportTask" + }, + { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#CopyDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#CopyDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#CopyDBSnapshot" + }, + { + "target": "com.amazonaws.rds#CopyOptionGroup" + }, + { + "target": "com.amazonaws.rds#CreateBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#CreateDBCluster" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#CreateDBInstance" + }, + { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplica" + }, + { + "target": "com.amazonaws.rds#CreateDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBProxy" + }, + { + "target": "com.amazonaws.rds#CreateDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#CreateDBSecurityGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBSnapshot" + }, + { + "target": "com.amazonaws.rds#CreateDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#CreateEventSubscription" + }, + { + "target": "com.amazonaws.rds#CreateGlobalCluster" + }, + { + "target": "com.amazonaws.rds#CreateOptionGroup" + }, + { + "target": "com.amazonaws.rds#DeleteBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#DeleteCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#DeleteDBCluster" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackup" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#DeleteDBInstance" + }, + { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup" + }, + { + "target": "com.amazonaws.rds#DeleteDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBProxy" + }, + { + "target": "com.amazonaws.rds#DeleteDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#DeleteDBSecurityGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBSnapshot" + }, + { + "target": "com.amazonaws.rds#DeleteDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#DeleteEventSubscription" + }, + { + "target": "com.amazonaws.rds#DeleteGlobalCluster" + }, + { + "target": "com.amazonaws.rds#DeleteOptionGroup" + }, + { + "target": "com.amazonaws.rds#DeregisterDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#DescribeAccountAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeBlueGreenDeployments" + }, + { + "target": "com.amazonaws.rds#DescribeCertificates" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackups" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterEndpoints" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterParameterGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterParameters" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusters" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshots" + }, + { + "target": "com.amazonaws.rds#DescribeDBEngineVersions" + }, + { + "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups" + }, + { + "target": "com.amazonaws.rds#DescribeDBInstances" + }, + { + "target": "com.amazonaws.rds#DescribeDBLogFiles" + }, + { + "target": "com.amazonaws.rds#DescribeDBParameterGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBParameters" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxies" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyEndpoints" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#DescribeDBSecurityGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeDBSnapshots" + }, + { + "target": "com.amazonaws.rds#DescribeDBSubnetGroups" + }, + { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParameters" + }, + { + "target": "com.amazonaws.rds#DescribeEngineDefaultParameters" + }, + { + "target": "com.amazonaws.rds#DescribeEventCategories" + }, + { + "target": "com.amazonaws.rds#DescribeEvents" + }, + { + "target": "com.amazonaws.rds#DescribeEventSubscriptions" + }, + { + "target": "com.amazonaws.rds#DescribeExportTasks" + }, + { + "target": "com.amazonaws.rds#DescribeGlobalClusters" + }, + { + "target": "com.amazonaws.rds#DescribeOptionGroupOptions" + }, + { + "target": "com.amazonaws.rds#DescribeOptionGroups" + }, + { + "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptions" + }, + { + "target": "com.amazonaws.rds#DescribePendingMaintenanceActions" + }, + { + "target": "com.amazonaws.rds#DescribeReservedDBInstances" + }, + { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferings" + }, + { + "target": "com.amazonaws.rds#DescribeSourceRegions" + }, + { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModifications" + }, + { + "target": "com.amazonaws.rds#DownloadDBLogFilePortion" + }, + { + "target": "com.amazonaws.rds#FailoverDBCluster" + }, + { + "target": "com.amazonaws.rds#FailoverGlobalCluster" + }, + { + "target": "com.amazonaws.rds#ListTagsForResource" + }, + { + "target": "com.amazonaws.rds#ModifyActivityStream" + }, + { + "target": "com.amazonaws.rds#ModifyCertificates" + }, + { + "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacity" + }, + { + "target": "com.amazonaws.rds#ModifyCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#ModifyDBCluster" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute" + }, + { + "target": "com.amazonaws.rds#ModifyDBInstance" + }, + { + "target": "com.amazonaws.rds#ModifyDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxy" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBSnapshot" + }, + { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttribute" + }, + { + "target": "com.amazonaws.rds#ModifyDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#ModifyEventSubscription" + }, + { + "target": "com.amazonaws.rds#ModifyGlobalCluster" + }, + { + "target": "com.amazonaws.rds#ModifyOptionGroup" + }, + { + "target": "com.amazonaws.rds#PromoteReadReplica" + }, + { + "target": "com.amazonaws.rds#PromoteReadReplicaDBCluster" + }, + { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOffering" + }, + { + "target": "com.amazonaws.rds#RebootDBCluster" + }, + { + "target": "com.amazonaws.rds#RebootDBInstance" + }, + { + "target": "com.amazonaws.rds#RegisterDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#RemoveFromGlobalCluster" + }, + { + "target": "com.amazonaws.rds#RemoveRoleFromDBCluster" + }, + { + "target": "com.amazonaws.rds#RemoveRoleFromDBInstance" + }, + { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription" + }, + { + "target": "com.amazonaws.rds#RemoveTagsFromResource" + }, + { + "target": "com.amazonaws.rds#ResetDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#ResetDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshot" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTime" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTime" + }, + { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngress" + }, + { + "target": "com.amazonaws.rds#StartActivityStream" + }, + { + "target": "com.amazonaws.rds#StartDBCluster" + }, + { + "target": "com.amazonaws.rds#StartDBInstance" + }, + { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication" + }, + { + "target": "com.amazonaws.rds#StartExportTask" + }, + { + "target": "com.amazonaws.rds#StopActivityStream" + }, + { + "target": "com.amazonaws.rds#StopDBCluster" + }, + { + "target": "com.amazonaws.rds#StopDBInstance" + }, + { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication" + }, + { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#SwitchoverGlobalCluster" + }, + { + "target": "com.amazonaws.rds#SwitchoverReadReplica" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "RDS", + "arnNamespace": "rds", + "cloudFormationName": "RDS", + "cloudTrailEventSource": "rds.amazonaws.com", + "endpointPrefix": "rds" + }, + "aws.auth#sigv4": { + "name": "rds" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Amazon Relational Database Service\n

\n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n

\n Amazon RDS API Reference\n

\n
    \n
  • \n

    For the alphabetical list of API actions, see \n API Actions.

    \n
    • \n
  • \n

    For the alphabetical list of data types, see \n Data Types.

    \n
    • \n
  • \n

    For a list of common query parameters, see \n Common Parameters.

    \n
    • \n
  • \n

    For descriptions of the error codes, see \n Common Errors.

    \n
    • \n
\n

\n Amazon RDS User Guide\n

\n ", + "smithy.api#title": "Amazon Relational Database Service", + "smithy.api#xmlNamespace": { + "uri": "http://rds.amazonaws.com/doc/2014-10-31/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" } + ] } - } - }, - "com.amazonaws.rds#AddRoleToDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AddRoleToDBClusterMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ + ], + "type": "tree", + "rules": [ { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "target": "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, { - "target": "com.amazonaws.rds#DBClusterRoleQuotaExceededFault" - }, + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] } - ], - "traits": { - "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with a DB cluster.

", - "smithy.api#examples": [ + ], + "type": "tree", + "rules": [ + { + "conditions": [ { - "title": "To associate an AWS Identity and Access Management (IAM) role with a DB cluster", - "documentation": "The following example associates a role with a DB cluster.", - "input": { - "DBClusterIdentifier": "mydbcluster", - "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" } + ], + "assign": "PartitionResult" } - ] - } - }, - "com.amazonaws.rds#AddRoleToDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster to associate the IAM role with.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB\n cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#AddRoleToDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AddRoleToDBInstanceMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n \n

This command doesn't apply to RDS Custom.

", - "smithy.api#examples": [ + ], + "type": "tree", + "rules": [ { - "title": "To associate an AWS Identity and Access Management (IAM) role with a DB instance", - "documentation": "The following example adds the role to a DB instance named test-instance.", - "input": { - "DBInstanceIdentifier": "test-instance", - "RoleArn": "arn:aws:iam::111122223333:role/rds-s3-integration-role", - "FeatureName": "S3_INTEGRATION" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } - } - ] - } - }, - "com.amazonaws.rds#AddRoleToDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB instance to associate the IAM role with.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#AddSourceIdentifierToSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#SourceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Adds a source identifier to an existing RDS event notification subscription.

", - "smithy.api#examples": [ + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rds-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, { - "title": "To add a source identifier to a subscription", - "documentation": "The following example adds another source identifier to an existing subscription.", - "input": { - "SubscriptionName": "my-instance-events", - "SourceIdentifier": "test-instance-repl" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://rds.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://rds-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] }, - "output": { - "EventSubscription": { - "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", - "CustSubscriptionId": "my-instance-events", - "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", - "Enabled": false, - "Status": "modifying", - "EventCategoriesList": [ - "backup", - "recovery" - ], - "CustomerAwsId": "123456789012", - "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", - "SourceType": "db-instance", - "SourceIdsList": [ - "test-instance", - "test-instance-repl" - ] + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rds.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://rds.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } - ] - } - }, - "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription you want to add a source identifier to.

", - "smithy.api#required": {} - } - }, - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the event source to be added.

\n

Constraints:

\n
    \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
", - "smithy.api#required": {} - } + ] } + ] }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } + ] }, - "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#output": {} + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } - }, - "com.amazonaws.rds#AddTagsToResource": { - "type": "operation", + ], + "version": "1.0" + } + } + }, + "com.amazonaws.rds#ApplyMethod": { + "type": "enum", + "members": { + "immediate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "immediate" + } + }, + "pending_reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-reboot" + } + } + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage" + }, + "output": { + "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a pending maintenance action to a resource (for example, to a DB instance).

", + "smithy.api#examples": [ + { + "title": "To apply pending maintenance actions", + "documentation": "The following example applies the pending maintenance actions for a DB cluster.", "input": { - "target": "com.amazonaws.rds#AddTagsToResourceMessage" + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "ApplyAction": "system-update", + "OptInType": "immediate" }, "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

", - "smithy.api#examples": [ - { - "title": "To add tags to a resource", - "documentation": "This example adds a tag to an option group.", - "input": { - "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup", - "Tags": [ - { - "Key": "Staging", - "Value": "LocationDB" - } - ] - } - } + "ResourcePendingMaintenanceActions": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "OptInStatus": "immediate", + "CurrentApplyDate": "2021-01-23T01:07:36.100Z", + "Description": "Upgrade to Aurora PostgreSQL 3.3.2" + } ] + } } - }, - "com.amazonaws.rds#AddTagsToResourceMessage": { - "type": "structure", - "members": { - "ResourceName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#AmazonRDSv19": { - "type": "service", - "version": "2014-10-31", - "operations": [ - { - "target": "com.amazonaws.rds#AddRoleToDBCluster" - }, - { - "target": "com.amazonaws.rds#AddRoleToDBInstance" - }, - { - "target": "com.amazonaws.rds#AddSourceIdentifierToSubscription" - }, - { - "target": "com.amazonaws.rds#AddTagsToResource" - }, - { - "target": "com.amazonaws.rds#ApplyPendingMaintenanceAction" - }, - { - "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress" - }, - { - "target": "com.amazonaws.rds#BacktrackDBCluster" - }, - { - "target": "com.amazonaws.rds#CancelExportTask" - }, - { - "target": "com.amazonaws.rds#CopyDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#CopyDBClusterSnapshot" - }, - { - "target": "com.amazonaws.rds#CopyDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#CopyDBSnapshot" - }, - { - "target": "com.amazonaws.rds#CopyOptionGroup" - }, - { - "target": "com.amazonaws.rds#CreateBlueGreenDeployment" - }, - { - "target": "com.amazonaws.rds#CreateCustomDBEngineVersion" - }, - { - "target": "com.amazonaws.rds#CreateDBCluster" - }, - { - "target": "com.amazonaws.rds#CreateDBClusterEndpoint" - }, - { - "target": "com.amazonaws.rds#CreateDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#CreateDBClusterSnapshot" - }, - { - "target": "com.amazonaws.rds#CreateDBInstance" - }, - { - "target": "com.amazonaws.rds#CreateDBInstanceReadReplica" - }, - { - "target": "com.amazonaws.rds#CreateDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#CreateDBProxy" - }, - { - "target": "com.amazonaws.rds#CreateDBProxyEndpoint" - }, - { - "target": "com.amazonaws.rds#CreateDBSecurityGroup" - }, - { - "target": "com.amazonaws.rds#CreateDBSnapshot" - }, - { - "target": "com.amazonaws.rds#CreateDBSubnetGroup" - }, - { - "target": "com.amazonaws.rds#CreateEventSubscription" - }, - { - "target": "com.amazonaws.rds#CreateGlobalCluster" - }, - { - "target": "com.amazonaws.rds#CreateOptionGroup" - }, - { - "target": "com.amazonaws.rds#DeleteBlueGreenDeployment" - }, - { - "target": "com.amazonaws.rds#DeleteCustomDBEngineVersion" - }, - { - "target": "com.amazonaws.rds#DeleteDBCluster" - }, - { - "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackup" - }, - { - "target": "com.amazonaws.rds#DeleteDBClusterEndpoint" - }, - { - "target": "com.amazonaws.rds#DeleteDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#DeleteDBClusterSnapshot" - }, - { - "target": "com.amazonaws.rds#DeleteDBInstance" - }, - { - "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup" - }, - { - "target": "com.amazonaws.rds#DeleteDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#DeleteDBProxy" - }, - { - "target": "com.amazonaws.rds#DeleteDBProxyEndpoint" - }, - { - "target": "com.amazonaws.rds#DeleteDBSecurityGroup" - }, - { - "target": "com.amazonaws.rds#DeleteDBSnapshot" - }, - { - "target": "com.amazonaws.rds#DeleteDBSubnetGroup" - }, - { - "target": "com.amazonaws.rds#DeleteEventSubscription" - }, - { - "target": "com.amazonaws.rds#DeleteGlobalCluster" - }, - { - "target": "com.amazonaws.rds#DeleteOptionGroup" - }, - { - "target": "com.amazonaws.rds#DeregisterDBProxyTargets" - }, - { - "target": "com.amazonaws.rds#DescribeAccountAttributes" - }, - { - "target": "com.amazonaws.rds#DescribeBlueGreenDeployments" - }, - { - "target": "com.amazonaws.rds#DescribeCertificates" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackups" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterEndpoints" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterParameterGroups" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterParameters" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusters" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshots" - }, - { - "target": "com.amazonaws.rds#DescribeDBEngineVersions" - }, - { - "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups" - }, - { - "target": "com.amazonaws.rds#DescribeDBInstances" - }, - { - "target": "com.amazonaws.rds#DescribeDBLogFiles" - }, - { - "target": "com.amazonaws.rds#DescribeDBParameterGroups" - }, - { - "target": "com.amazonaws.rds#DescribeDBParameters" - }, - { - "target": "com.amazonaws.rds#DescribeDBProxies" - }, - { - "target": "com.amazonaws.rds#DescribeDBProxyEndpoints" - }, - { - "target": "com.amazonaws.rds#DescribeDBProxyTargetGroups" - }, - { - "target": "com.amazonaws.rds#DescribeDBProxyTargets" - }, - { - "target": "com.amazonaws.rds#DescribeDBSecurityGroups" - }, - { - "target": "com.amazonaws.rds#DescribeDBSnapshotAttributes" - }, - { - "target": "com.amazonaws.rds#DescribeDBSnapshots" - }, - { - "target": "com.amazonaws.rds#DescribeDBSubnetGroups" - }, - { - "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParameters" - }, - { - "target": "com.amazonaws.rds#DescribeEngineDefaultParameters" - }, - { - "target": "com.amazonaws.rds#DescribeEventCategories" - }, - { - "target": "com.amazonaws.rds#DescribeEvents" - }, - { - "target": "com.amazonaws.rds#DescribeEventSubscriptions" - }, - { - "target": "com.amazonaws.rds#DescribeExportTasks" - }, - { - "target": "com.amazonaws.rds#DescribeGlobalClusters" - }, - { - "target": "com.amazonaws.rds#DescribeOptionGroupOptions" - }, - { - "target": "com.amazonaws.rds#DescribeOptionGroups" - }, - { - "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptions" - }, - { - "target": "com.amazonaws.rds#DescribePendingMaintenanceActions" - }, - { - "target": "com.amazonaws.rds#DescribeReservedDBInstances" - }, - { - "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferings" - }, - { - "target": "com.amazonaws.rds#DescribeSourceRegions" - }, - { - "target": "com.amazonaws.rds#DescribeValidDBInstanceModifications" - }, - { - "target": "com.amazonaws.rds#DownloadDBLogFilePortion" - }, - { - "target": "com.amazonaws.rds#FailoverDBCluster" - }, - { - "target": "com.amazonaws.rds#FailoverGlobalCluster" - }, - { - "target": "com.amazonaws.rds#ListTagsForResource" - }, - { - "target": "com.amazonaws.rds#ModifyActivityStream" - }, - { - "target": "com.amazonaws.rds#ModifyCertificates" - }, - { - "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacity" - }, - { - "target": "com.amazonaws.rds#ModifyCustomDBEngineVersion" - }, - { - "target": "com.amazonaws.rds#ModifyDBCluster" - }, - { - "target": "com.amazonaws.rds#ModifyDBClusterEndpoint" - }, - { - "target": "com.amazonaws.rds#ModifyDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute" - }, - { - "target": "com.amazonaws.rds#ModifyDBInstance" - }, - { - "target": "com.amazonaws.rds#ModifyDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#ModifyDBProxy" - }, - { - "target": "com.amazonaws.rds#ModifyDBProxyEndpoint" - }, - { - "target": "com.amazonaws.rds#ModifyDBProxyTargetGroup" - }, - { - "target": "com.amazonaws.rds#ModifyDBSnapshot" - }, - { - "target": "com.amazonaws.rds#ModifyDBSnapshotAttribute" - }, - { - "target": "com.amazonaws.rds#ModifyDBSubnetGroup" - }, - { - "target": "com.amazonaws.rds#ModifyEventSubscription" - }, - { - "target": "com.amazonaws.rds#ModifyGlobalCluster" - }, - { - "target": "com.amazonaws.rds#ModifyOptionGroup" - }, - { - "target": "com.amazonaws.rds#PromoteReadReplica" - }, - { - "target": "com.amazonaws.rds#PromoteReadReplicaDBCluster" - }, - { - "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOffering" - }, - { - "target": "com.amazonaws.rds#RebootDBCluster" - }, - { - "target": "com.amazonaws.rds#RebootDBInstance" - }, - { - "target": "com.amazonaws.rds#RegisterDBProxyTargets" - }, - { - "target": "com.amazonaws.rds#RemoveFromGlobalCluster" - }, - { - "target": "com.amazonaws.rds#RemoveRoleFromDBCluster" - }, - { - "target": "com.amazonaws.rds#RemoveRoleFromDBInstance" - }, - { - "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription" - }, - { - "target": "com.amazonaws.rds#RemoveTagsFromResource" - }, - { - "target": "com.amazonaws.rds#ResetDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#ResetDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#RestoreDBClusterFromS3" - }, - { - "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshot" - }, - { - "target": "com.amazonaws.rds#RestoreDBClusterToPointInTime" - }, - { - "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot" - }, - { - "target": "com.amazonaws.rds#RestoreDBInstanceFromS3" - }, - { - "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTime" - }, - { - "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngress" - }, - { - "target": "com.amazonaws.rds#StartActivityStream" - }, - { - "target": "com.amazonaws.rds#StartDBCluster" - }, - { - "target": "com.amazonaws.rds#StartDBInstance" - }, - { - "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication" - }, - { - "target": "com.amazonaws.rds#StartExportTask" - }, - { - "target": "com.amazonaws.rds#StopActivityStream" - }, - { - "target": "com.amazonaws.rds#StopDBCluster" - }, - { - "target": "com.amazonaws.rds#StopDBInstance" - }, - { - "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication" - }, - { - "target": "com.amazonaws.rds#SwitchoverBlueGreenDeployment" - }, - { - "target": "com.amazonaws.rds#SwitchoverReadReplica" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "RDS", - "arnNamespace": "rds", - "cloudFormationName": "RDS", - "cloudTrailEventSource": "rds.amazonaws.com", - "endpointPrefix": "rds" - }, - "aws.auth#sigv4": { - "name": "rds" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon Relational Database Service\n

\n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n

\n Amazon RDS API Reference\n

\n
    \n
  • \n

    For the alphabetical list of API actions, see \n API Actions.

    \n
    • \n
  • \n

    For the alphabetical list of data types, see \n Data Types.

    \n
    • \n
  • \n

    For a list of common query parameters, see \n Common Parameters.

    \n
    • \n
  • \n

    For descriptions of the error codes, see \n Common Errors.

    \n
    • \n
\n

\n Amazon RDS User Guide\n

\n ", - "smithy.api#title": "Amazon Relational Database Service", - "smithy.api#xmlNamespace": { - "uri": "http://rds.amazonaws.com/doc/2014-10-31/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://rds-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://rds.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://rds-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://rds.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://rds.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.rds#ApplyMethod": { - "type": "enum", - "members": { - "immediate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "immediate" - } - }, - "pending_reboot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-reboot" - } - } - } - }, - "com.amazonaws.rds#ApplyPendingMaintenanceAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage" - }, - "output": { - "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Applies a pending maintenance action to a resource (for example, to a DB instance).

", - "smithy.api#examples": [ - { - "title": "To apply pending maintenance actions", - "documentation": "The following example applies the pending maintenance actions for a DB cluster.", - "input": { - "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", - "ApplyAction": "system-update", - "OptInType": "immediate" - }, - "output": { - "ResourcePendingMaintenanceActions": { - "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", - "PendingMaintenanceActionDetails": [ - { - "Action": "system-update", - "OptInStatus": "immediate", - "CurrentApplyDate": "2021-01-23T01:07:36.100Z", - "Description": "Upgrade to Aurora PostgreSQL 3.3.2" - } - ] - } - } - } - ] - } - }, - "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { - "type": "structure", - "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The RDS Amazon Resource Name (ARN) of the resource that the \n pending maintenance action applies to. For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "ApplyAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

", - "smithy.api#required": {} - } - }, - "OptInType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid values:

\n
    \n
  • \n

    \n immediate - Apply the maintenance action immediately.

    \n
    • \n
  • \n

    \n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.

    \n
    • \n
  • \n

    \n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.

    \n
    • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ApplyPendingMaintenanceActionResult": { - "type": "structure", - "members": { - "ResourcePendingMaintenanceActions": { - "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#AttributeValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "AttributeValue" - } - } - }, - "com.amazonaws.rds#AuditPolicyState": { - "type": "enum", - "members": { - "LOCKED_POLICY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "locked" - } - }, - "UNLOCKED_POLICY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unlocked" - } - } - } - }, - "com.amazonaws.rds#AuthScheme": { - "type": "enum", - "members": { - "SECRETS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECRETS" - } - } - } - }, - "com.amazonaws.rds#AuthorizationAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AuthorizationAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group is already authorized for\n the specified DB security group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#AuthorizationNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AuthorizationNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.

\n

Or, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#AuthorizationQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AuthorizationQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB security group authorization quota has been reached.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage" - }, - "output": { - "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#AuthorizationQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", - "smithy.api#examples": [ - { - "title": "To authorize DB security group integress", - "documentation": "This example authorizes access to the specified security group by the specified CIDR block.", - "input": { - "DBSecurityGroupName": "mydbsecuritygroup", - "CIDRIP": "203.0.113.5/32" - }, - "output": { - "DBSecurityGroup": {} - } - } - ] - } - }, - "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group to add authorization to.

", - "smithy.api#required": {} - } - }, - "CIDRIP": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The IP range to authorize.

" - } - }, - "EC2SecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName \n or EC2SecurityGroupId must be provided.

" - } - }, - "EC2SecurityGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - }, - "EC2SecurityGroupOwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult": { - "type": "structure", - "members": { - "DBSecurityGroup": { - "target": "com.amazonaws.rds#DBSecurityGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#AutomationMode": { - "type": "enum", - "members": { - "FULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "full" - } - }, - "ALL_PAUSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "all-paused" - } - } - } - }, - "com.amazonaws.rds#AvailabilityZone": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains Availability Zone information.

\n

This data type is used as an element in the OrderableDBInstanceOption\n data type.

" - } - }, - "com.amazonaws.rds#AvailabilityZoneList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#AvailabilityZone", - "traits": { - "smithy.api#xmlName": "AvailabilityZone" - } - } - }, - "com.amazonaws.rds#AvailabilityZones": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "AvailabilityZone" - } - } - }, - "com.amazonaws.rds#AvailableProcessorFeature": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount \n and threadsPerCore.

" - } - }, - "DefaultValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The default value for the processor feature of the DB instance class.

" - } - }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The allowed values for the processor feature of the DB instance class.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the available processor feature information for the DB instance class of a DB instance.

\n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" - } - }, - "com.amazonaws.rds#AvailableProcessorFeatureList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#AvailableProcessorFeature", - "traits": { - "smithy.api#xmlName": "AvailableProcessorFeature" - } - } - }, - "com.amazonaws.rds#AwsBackupRecoveryPointArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 43, - "max": 350 - }, - "smithy.api#pattern": "^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$" - } - }, - "com.amazonaws.rds#BacktrackDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#BacktrackDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterBacktrack" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.

\n \n

This action applies only to Aurora MySQL DB clusters.

\n " - } - }, - "com.amazonaws.rds#BacktrackDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "BacktrackTo": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n

\n \n

If the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.

\n \n

Constraints:

\n
    \n
  • \n

    Must contain a valid ISO 8601 timestamp.

    \n
    • \n
  • \n

    Can't contain a timestamp set in the future.

    \n
    • \n
\n

Example: 2017-07-08T18:00Z\n

", - "smithy.api#required": {} - } - }, - "Force": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

" - } - }, - "UseEarliestTimeOnPointInTimeUnavailable": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#BackupPolicyNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "BackupPolicyNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#deprecated": { - "message": "Please avoid using this fault" - }, - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#BlueGreenDeployment": { - "type": "structure", - "members": { - "BlueGreenDeploymentIdentifier": { - "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier of the blue/green deployment.

" - } - }, - "BlueGreenDeploymentName": { - "target": "com.amazonaws.rds#BlueGreenDeploymentName", - "traits": { - "smithy.api#documentation": "

The user-supplied name of the blue/green deployment.

" - } - }, - "Source": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The source database for the blue/green deployment.

\n

Before switchover, the source database is the production database in the blue environment.

" - } - }, - "Target": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The target database for the blue/green deployment.

\n

Before switchover, the target database is the clone database in the green environment.

" - } - }, - "SwitchoverDetails": { - "target": "com.amazonaws.rds#SwitchoverDetailList", - "traits": { - "smithy.api#documentation": "

The details about each source and target resource in the blue/green deployment.

" - } - }, - "Tasks": { - "target": "com.amazonaws.rds#BlueGreenDeploymentTaskList", - "traits": { - "smithy.api#documentation": "

Either tasks to be performed or tasks that have been completed on the target database before switchover.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#BlueGreenDeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the blue/green deployment.

\n

Valid Values:

\n
    \n
  • \n

    \n PROVISIONING - Resources are being created in the green environment.

    \n
    • \n
  • \n

    \n AVAILABLE - Resources are available in the green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the \n green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.

    \n
    • \n
  • \n

    \n INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.

    \n
    • \n
  • \n

    \n SWITCHOVER_FAILED - Switchover was attempted but failed.

    \n
    • \n
  • \n

    \n DELETING - The blue/green deployment is being deleted.

    \n
    • \n
" - } - }, - "StatusDetails": { - "target": "com.amazonaws.rds#BlueGreenDeploymentStatusDetails", - "traits": { - "smithy.api#documentation": "

Additional information about the status of the blue/green deployment.

" - } - }, - "CreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when the blue/green deployment was created, in Universal Coordinated Time\n (UTC).

" - } - }, - "DeleteTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when the blue/green deployment was deleted, in Universal Coordinated Time\n (UTC).

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

Details about a blue/green deployment.

\n

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

" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "BlueGreenDeploymentAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A blue/green deployment with the specified name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#BlueGreenDeploymentIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#BlueGreenDeployment" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "BlueGreenDeploymentNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#BlueGreenDeploymentStatus": { - "type": "string" - }, - "com.amazonaws.rds#BlueGreenDeploymentStatusDetails": { - "type": "string" - }, - "com.amazonaws.rds#BlueGreenDeploymentTask": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#BlueGreenDeploymentTaskName", - "traits": { - "smithy.api#documentation": "

The name of the blue/green deployment task.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#BlueGreenDeploymentTaskStatus", - "traits": { - "smithy.api#documentation": "

The status of the blue/green deployment task.

\n

Valid Values:

\n
    \n
  • \n

    \n PENDING - The resource is being prepared for deployment.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The resource is being deployed.

    \n
    • \n
  • \n

    \n COMPLETED - The resource has been deployed.

    \n
    • \n
  • \n

    \n FAILED - Deployment of the resource failed.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a task for a blue/green deployment.

\n

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

" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#BlueGreenDeploymentTask" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentTaskName": { - "type": "string" - }, - "com.amazonaws.rds#BlueGreenDeploymentTaskStatus": { - "type": "string" - }, - "com.amazonaws.rds#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.rds#BooleanOptional": { - "type": "boolean" - }, - "com.amazonaws.rds#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.rds#CACertificateIdentifiersList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#CancelExportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CancelExportTaskMessage" - }, - "output": { - "target": "com.amazonaws.rds#ExportTask" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ExportTaskNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidExportTaskStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.

", - "smithy.api#examples": [ - { - "title": "To cancel a snapshot export to Amazon S3", - "documentation": "The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.", - "input": { - "ExportTaskIdentifier": "my-s3-export-1" - }, - "output": { - "ExportTaskIdentifier": "my-s3-export-1", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot", - "SnapshotTime": "2019-03-24T20:01:09.815Z", - "S3Bucket": "mybucket", - "S3Prefix": "", - "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role", - "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff", - "Status": "CANCELING", - "PercentProgress": 0, - "TotalExtractedDataInGB": 0 - } - } - ] - } - }, - "com.amazonaws.rds#CancelExportTaskMessage": { - "type": "structure", - "members": { - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the snapshot or cluster export task to cancel.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#Certificate": { - "type": "structure", - "members": { - "CertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The unique key that identifies a certificate.

" - } - }, - "CertificateType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of the certificate.

" - } - }, - "Thumbprint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The thumbprint of the certificate.

" - } - }, - "ValidFrom": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The starting date from which the certificate is valid.

" - } - }, - "ValidTill": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The final date that the certificate continues to be valid.

" - } - }, - "CertificateArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" - } - }, - "CustomerOverride": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether there is an override for the default certificate identifier.

" - } - }, - "CustomerOverrideValidTill": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

If there is an override for the default certificate identifier, when the override\n expires.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A CA certificate for an Amazon Web Services account.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" - } - }, - "com.amazonaws.rds#CertificateDetails": { - "type": "structure", - "members": { - "CAIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The CA identifier of the CA certificate used for the DB instance's server certificate.

" - } - }, - "ValidTill": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The expiration date of the DB instance’s server certificate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Returns the details of the DB instance’s server certificate.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" - } - }, - "com.amazonaws.rds#CertificateList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Certificate", - "traits": { - "smithy.api#xmlName": "Certificate" - } - } - }, - "com.amazonaws.rds#CertificateMessage": { - "type": "structure", - "members": { - "Certificates": { - "target": "com.amazonaws.rds#CertificateList", - "traits": { - "smithy.api#documentation": "

The list of Certificate objects for the Amazon Web Services account.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned by the DescribeCertificates action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CertificateNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CertificateNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an\n existing certificate.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#CharacterSet": { - "type": "structure", - "members": { - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the character set.

" - } - }, - "CharacterSetDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the character set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" - } - }, - "com.amazonaws.rds#ClientPasswordAuthType": { - "type": "enum", - "members": { - "MYSQL_NATIVE_PASSWORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MYSQL_NATIVE_PASSWORD" - } - }, - "POSTGRES_SCRAM_SHA_256": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRES_SCRAM_SHA_256" - } - }, - "POSTGRES_MD5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRES_MD5" - } - }, - "SQL_SERVER_AUTHENTICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_SERVER_AUTHENTICATION" - } - } - } - }, - "com.amazonaws.rds#CloudwatchLogsExportConfiguration": { - "type": "structure", - "members": { - "EnableLogTypes": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of log types to enable.

" - } - }, - "DisableLogTypes": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of log types to disable.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.

\n

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#ClusterPendingModifiedValues": { - "type": "structure", - "members": { - "PendingCloudwatchLogsExports": { - "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DBClusterIdentifier value for the DB cluster.

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The master credentials for the DB cluster.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine version.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, \n AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but \n instead automatically adjusts as needed.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type for the DB cluster.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBCluster operation and \n contains changes that will be applied during the next maintenance window.

" - } - }, - "com.amazonaws.rds#ConnectionPoolConfiguration": { - "type": "structure", - "members": { - "MaxConnectionsPercent": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints: Must be between 1 and 100.

" - } - }, - "MaxIdleConnectionsPercent": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

\n

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

" - } - }, - "ConnectionBorrowTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

\n

Default: 120

\n

Constraints: between 1 and 3600, or 0 representing unlimited

" - } - }, - "SessionPinningFilters": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

\n

Default: no session pinning filters

" - } - }, - "InitQuery": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

\n

Default: no initialization query

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

" - } - }, - "com.amazonaws.rds#ConnectionPoolConfigurationInfo": { - "type": "structure", - "members": { - "MaxConnectionsPercent": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

" - } - }, - "MaxIdleConnectionsPercent": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

" - } - }, - "ConnectionBorrowTimeout": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

" - } - }, - "SessionPinningFilters": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. \n Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

" - } - }, - "InitQuery": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

" - } - }, - "com.amazonaws.rds#CopyDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyDBClusterParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyDBClusterParameterGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies the specified DB cluster parameter group.

", - "smithy.api#examples": [ - { - "title": "To copy a DB cluster parameter group", - "documentation": "This example copies a DB cluster parameter group.", - "input": { - "SourceDBClusterParameterGroupIdentifier": "mydbclusterparametergroup", - "TargetDBClusterParameterGroupIdentifier": "mydbclusterparametergroup-copy", - "TargetDBClusterParameterGroupDescription": "My DB cluster parameter group copy" - }, - "output": { - "DBClusterParameterGroup": { - "DBClusterParameterGroupName": "mydbclusterparametergroup-copy", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy", - "DBParameterGroupFamily": "aurora-mysql5.7", - "Description": "My DB cluster parameter group copy" - } - } - } - ] - } - }, - "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "SourceDBClusterParameterGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid DB cluster parameter group.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "TargetDBClusterParameterGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the copied DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-cluster-param-group1\n

", - "smithy.api#required": {} - } - }, - "TargetDBClusterParameterGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A description for the copied DB cluster parameter group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CopyDBClusterParameterGroupResult": { - "type": "structure", - "members": { - "DBClusterParameterGroup": { - "target": "com.amazonaws.rds#DBClusterParameterGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CopyDBClusterSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyDBClusterSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyDBClusterSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:

\n
    \n
  • \n

    \n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned URL.

    \n
    • \n
\n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To copy a DB cluster snapshot", - "documentation": "The following example creates a copy of a DB cluster snapshot, including its tags.", - "input": { - "SourceDBClusterSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16", - "TargetDBClusterSnapshotIdentifier": "myclustersnapshotcopy", - "CopyTags": true - }, - "output": { - "DBClusterSnapshot": { - "AvailabilityZones": [ - "us-east-1a", - "us-east-1b", - "us-east-1e" - ], - "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", - "DBClusterIdentifier": "myaurora", - "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", - "Engine": "aurora-mysql", - "AllocatedStorage": 0, - "Status": "available", - "Port": 0, - "VpcId": "vpc-123example", - "ClusterCreateTime": "2019-04-15T14:18:42.785Z", - "MasterUsername": "myadmin", - "EngineVersion": "5.7.mysql_aurora.2.04.2", - "LicenseModel": "aurora-mysql", - "SnapshotType": "manual", - "PercentProgress": 100, - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", - "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy", - "IAMDatabaseAuthenticationEnabled": false - } - } - } - ] - } - }, - "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { - "type": "structure", - "members": { - "SourceDBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
  • \n

    If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

    \n
    • \n
  • \n

    If the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

    \n
    • \n
\n

Example: my-cluster-snapshot1\n

", - "smithy.api#required": {} - } - }, - "TargetDBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster-snapshot2\n

", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

\n

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

\n

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

\n

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.

\n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region \n that the DB cluster snapshot is to be created in.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " - } - }, - "CopyTags": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CopyDBClusterSnapshotResult": { - "type": "structure", - "members": { - "DBClusterSnapshot": { - "target": "com.amazonaws.rds#DBClusterSnapshot" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CopyDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyDBParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyDBParameterGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies the specified DB parameter group.

", - "smithy.api#examples": [ - { - "title": "To copy a DB parameter group", - "documentation": "The following example makes a copy of a DB parameter group.", - "input": { - "SourceDBParameterGroupIdentifier": "mydbpg", - "TargetDBParameterGroupIdentifier": "mydbpgcopy", - "TargetDBParameterGroupDescription": "Copy of mydbpg parameter group" - }, - "output": { - "DBParameterGroup": { - "DBParameterGroupName": "mydbpgcopy", - "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", - "DBParameterGroupFamily": "mysql5.7", - "Description": "Copy of mydbpg parameter group" - } - } - } - ] - } - }, - "com.amazonaws.rds#CopyDBParameterGroupMessage": { - "type": "structure", - "members": { - "SourceDBParameterGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid DB parameter group.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "TargetDBParameterGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-db-parameter-group\n

", - "smithy.api#required": {} - } - }, - "TargetDBParameterGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A description for the copied DB parameter group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CopyDBParameterGroupResult": { - "type": "structure", - "members": { - "DBParameterGroup": { - "target": "com.amazonaws.rds#DBParameterGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CopyDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.

\n

This command doesn't apply to RDS Custom.

\n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

", - "smithy.api#examples": [ - { - "title": "To copy a DB snapshot", - "documentation": "The following example creates a copy of a DB snapshot.", - "input": { - "SourceDBSnapshotIdentifier": "rds:database-mysql-2019-06-06-08-38", - "TargetDBSnapshotIdentifier": "mydbsnapshotcopy" - }, - "output": { - "DBSnapshot": { - "VpcId": "vpc-6594f31c", - "Status": "creating", - "Encrypted": true, - "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", - "MasterUsername": "admin", - "Iops": 1000, - "Port": 3306, - "LicenseModel": "general-public-license", - "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", - "EngineVersion": "5.6.40", - "OptionGroupName": "default:mysql-5-6", - "ProcessorFeatures": [], - "Engine": "mysql", - "StorageType": "io1", - "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", - "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", - "SnapshotType": "manual", - "IAMDatabaseAuthenticationEnabled": false, - "SourceRegion": "us-east-1", - "DBInstanceIdentifier": "database-mysql", - "InstanceCreateTime": "2019-04-30T15:45:53.663Z", - "AvailabilityZone": "us-east-1f", - "PercentProgress": 0, - "AllocatedStorage": 100, - "DBSnapshotIdentifier": "mydbsnapshotcopy" - } - } - } - ] - } - }, - "com.amazonaws.rds#CopyDBSnapshotMessage": { - "type": "structure", - "members": { - "SourceDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
\n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", - "smithy.api#required": {} - } - }, - "TargetDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the copy of the snapshot.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-db-snapshot\n

", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

\n

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.

\n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.

\n

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "CopyTags": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.

    \n

    For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.

    \n
    • \n
  • \n

    \n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.

" - } - }, - "TargetCustomAvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The external custom Availability Zone (CAZ) identifier for the target CAZ.

\n

Example: rds-caz-aiqhTgQv.

" - } - }, - "CopyOptionGroup": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CopyDBSnapshotResult": { - "type": "structure", - "members": { - "DBSnapshot": { - "target": "com.amazonaws.rds#DBSnapshot" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CopyOptionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyOptionGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyOptionGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies the specified option group.

", - "smithy.api#examples": [ - { - "title": "To copy an option group", - "documentation": "The following example makes a copy of an option group.", - "input": { - "SourceOptionGroupIdentifier": "myoptiongroup", - "TargetOptionGroupIdentifier": "new-option-group", - "TargetOptionGroupDescription": "My option group copy" - }, - "output": { - "OptionGroup": { - "Options": [], - "OptionGroupName": "new-option-group", - "MajorEngineVersion": "11.2", - "OptionGroupDescription": "My option group copy", - "AllowsVpcAndNonVpcInstanceMemberships": true, - "EngineName": "oracle-ee", - "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" - } - } - } - ] - } - }, - "com.amazonaws.rds#CopyOptionGroupMessage": { - "type": "structure", - "members": { - "SourceOptionGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source option group.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid option group.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "TargetOptionGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the copied option group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-option-group\n

", - "smithy.api#required": {} - } - }, - "TargetOptionGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the copied option group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CopyOptionGroupResult": { - "type": "structure", - "members": { - "OptionGroup": { - "target": "com.amazonaws.rds#OptionGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateBlueGreenDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateBlueGreenDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.rds#CreateBlueGreenDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#SourceClusterNotSupportedFault" - }, - { - "target": "com.amazonaws.rds#SourceDatabaseNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a blue/green deployment.

\n

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

\n

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

\n

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

" - } - }, - "com.amazonaws.rds#CreateBlueGreenDeploymentRequest": { - "type": "structure", - "members": { - "BlueGreenDeploymentName": { - "target": "com.amazonaws.rds#BlueGreenDeploymentName", - "traits": { - "smithy.api#documentation": "

The name of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

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

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

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

\n

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

", - "smithy.api#required": {} - } - }, - "TargetEngineVersion": { - "target": "com.amazonaws.rds#TargetEngineVersion", - "traits": { - "smithy.api#documentation": "

The engine version of the database in the green environment.

\n

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

" - } - }, - "TargetDBParameterGroupName": { - "target": "com.amazonaws.rds#TargetDBParameterGroupName", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "TargetDBClusterParameterGroupName": { - "target": "com.amazonaws.rds#TargetDBClusterParameterGroupName", - "traits": { - "smithy.api#documentation": "

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

\n

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

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the blue/green deployment.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateBlueGreenDeploymentResponse": { - "type": "structure", - "members": { - "BlueGreenDeployment": { - "target": "com.amazonaws.rds#BlueGreenDeployment" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateCustomDBEngineVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateCustomDBEngineVersionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBEngineVersion" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CreateCustomDBEngineVersionFault" - }, - { - "target": "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom DB engine version (CEV).

" - } - }, - "com.amazonaws.rds#CreateCustomDBEngineVersionFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CreateCustomDBEngineVersionFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

An error occurred while trying to create the CEV.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#CustomEngineName", - "traits": { - "smithy.api#documentation": "

The database engine to use for your custom engine version (CEV). The only supported value is \n custom-oracle-ee.

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#CustomEngineVersion", - "traits": { - "smithy.api#documentation": "

The name of your CEV. The name format is 19.customized_string.\n For example, a valid CEV name is 19.my_cev1. This setting is required for RDS\n Custom for Oracle, but optional for Amazon RDS. The combination of Engine\n and EngineVersion is unique per customer per Region.

", - "smithy.api#required": {} - } - }, - "DatabaseInstallationFilesS3BucketName": { - "target": "com.amazonaws.rds#BucketName", - "traits": { - "smithy.api#documentation": "

The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid \n bucket name is my-custom-installation-files.

" - } - }, - "DatabaseInstallationFilesS3Prefix": { - "target": "com.amazonaws.rds#String255", - "traits": { - "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid \n bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

" - } - }, - "ImageId": { - "target": "com.amazonaws.rds#String255", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required \n to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, \n but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs \n used by your CEVs by calling the DescribeDBEngineVersions operation.

" - } - }, - "KMSKeyId": { - "target": "com.amazonaws.rds#KmsKeyIdOrArn", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.

\n

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.

\n

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#Description", - "traits": { - "smithy.api#documentation": "

An optional description of your CEV.

" - } - }, - "Manifest": { - "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", - "traits": { - "smithy.api#documentation": "

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.

\n

The following JSON fields are valid:

\n
\n
MediaImportTemplateVersion
\n
\n

Version of the CEV manifest. The date is in the format YYYY-MM-DD.

\n
\n
databaseInstallationFileNames
\n
\n

Ordered list of installation files for the CEV.

\n
\n
opatchFileNames
\n
\n

Ordered list of OPatch installers used for the Oracle DB engine.

\n
\n
psuRuPatchFileNames
\n
\n

The PSU and RU patches for this CEV.

\n
\n
OtherPatchFileNames
\n
\n

The patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.

\n
\n
\n

For more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

If you create an Aurora DB cluster, the request creates an empty cluster. You must\n explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the\n request creates a writer and two reader DB instances for you, each in a different\n Availability Zone.

\n

You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or\n PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User\n Guide.

\n

You can also use the ReplicationSourceIdentifier parameter to create a\n Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the\n source. For more information about Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To create a MySQL 5.7-compatible DB cluster", - "documentation": "The following example creates a MySQL 5.7-compatible Aurora DB cluster.", - "input": { - "DBClusterIdentifier": "sample-cluster", - "Engine": "aurora-mysql", - "EngineVersion": "5.7.12", - "MasterUsername": "admin", - "MasterUserPassword": "mypassword", - "DBSubnetGroupName": "default", - "VpcSecurityGroupIds": [ - "sg-0b91305example" - ] - }, - "output": { - "DBCluster": { - "DBSubnetGroup": "default", - "VpcSecurityGroups": [ - { - "VpcSecurityGroupId": "sg-0b91305example", - "Status": "active" - } - ], - "AllocatedStorage": 1, - "AssociatedRoles": [], - "PreferredBackupWindow": "09:12-09:42", - "ClusterCreateTime": "2019-06-07T23:21:33.048Z", - "DeletionProtection": false, - "IAMDatabaseAuthenticationEnabled": false, - "ReadReplicaIdentifiers": [], - "EngineMode": "provisioned", - "Engine": "aurora-mysql", - "StorageEncrypted": false, - "MultiAZ": false, - "PreferredMaintenanceWindow": "mon:04:31-mon:05:01", - "HttpEndpointEnabled": false, - "BackupRetentionPeriod": 1, - "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", - "DBClusterIdentifier": "sample-cluster", - "AvailabilityZones": [ - "us-east-1a", - "us-east-1b", - "us-east-1e" - ], - "MasterUsername": "master", - "EngineVersion": "5.7.12", - "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster", - "DBClusterMembers": [], - "Port": 3306, - "Status": "creating", - "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", - "DBClusterParameterGroup": "default.aurora-mysql5.7", - "HostedZoneId": "Z2R2ITUGPM61AM", - "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", - "CopyTagsToSnapshot": false - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBClusterEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBClusterEndpointMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterEndpoint" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action applies only to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To create a custom DB cluster endpoint", - "documentation": "The following example creates a custom DB cluster endpoint and associate it with the specified Aurora DB cluster.", - "input": { - "DBClusterIdentifier": "mydbcluster", - "DBClusterEndpointIdentifier": "mycustomendpoint", - "EndpointType": "reader", - "StaticMembers": [ - "dbinstance1", - "dbinstance2" - ] - }, - "output": { - "DBClusterEndpointIdentifier": "mycustomendpoint", - "DBClusterIdentifier": "mydbcluster", - "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", - "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", - "Status": "creating", - "EndpointType": "CUSTOM", - "CustomEndpointType": "READER", - "StaticMembers": [ - "dbinstance1", - "dbinstance2" - ], - "ExcludedMembers": [], - "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBClusterEndpointMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

", - "smithy.api#required": {} - } - }, - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

", - "smithy.api#required": {} - } - }, - "EndpointType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of the endpoint, one of: READER, WRITER, ANY.

", - "smithy.api#required": {} - } - }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" - } - }, - "ExcludedMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n This parameter is relevant only if the list of static members is empty.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBClusterMessage": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

\n

For information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35.

    \n
    • \n
" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the character set (CharacterSet) to associate the DB cluster with.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you don't\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for this DB cluster. This parameter is stored as a lowercase string.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with this DB cluster. If you don't specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \n
" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB subnet group.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres\n

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),\n use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or\n version 3, respectively.

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

For information about a specific engine, see the following topics:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    RDS for MySQL and Aurora MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for PostgreSQL and Aurora PostgreSQL - 5432\n

    \n
    • \n
" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group to associate the DB cluster with.

\n

DB clusters are associated with a default option group that can't be modified.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "ReplicationSourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When a KMS key isn't specified in KmsKeyId:

\n
    \n
  • \n

    If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS uses the KMS key used to encrypt the\n source. Otherwise, Amazon RDS uses your default KMS key.

    \n
    • \n
  • \n

    If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n uses your default KMS key.

    \n
    • \n
\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make\n sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.

    \n
    • \n
  • \n

    \n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Valid for Cluster Type: Aurora MySQL DB clusters only

\n

Default: 0\n

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\n

For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "EnableHttpEndpoint": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB cluster in.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "EnableGlobalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

This setting is required to create a Multi-AZ DB cluster.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    Aurora DB clusters - aurora | aurora-iopt1\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
\n

Default:

\n
    \n
  • \n

    Aurora DB clusters - aurora\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

    \n
    • \n
" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableLocalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBClusterParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBClusterParameterGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB cluster parameter group.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

\n

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.

\n

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To create a DB cluster parameter group", - "documentation": "The following example creates a DB cluster parameter group.", - "input": { - "DBClusterParameterGroupName": "mydbclusterparametergroup", - "DBParameterGroupFamily": "aurora5.6", - "Description": "My new cluster parameter group" - }, - "output": { - "DBClusterParameterGroup": { - "DBClusterParameterGroupName": "mydbclusterparametergroup", - "DBParameterGroupFamily": "aurora5.6", - "Description": "My new cluster parameter group", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must not match the name of an existing DB cluster parameter group.

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n ", - "smithy.api#required": {} - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora-mysql5.7, aurora-mysql8.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql14\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres12\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB cluster parameter group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB cluster parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBClusterParameterGroupResult": { - "type": "structure", - "members": { - "DBClusterParameterGroup": { - "target": "com.amazonaws.rds#DBClusterParameterGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBClusterSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBClusterSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBClusterSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of a DB cluster.

\n

For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To create a DB cluster snapshot", - "documentation": "The following example creates a DB cluster snapshot.", - "input": { - "DBClusterSnapshotIdentifier": "mydbcluster", - "DBClusterIdentifier": "mydbclustersnapshot" - }, - "output": { - "DBClusterSnapshot": { - "AvailabilityZones": [ - "us-east-1a", - "us-east-1b", - "us-east-1e" - ], - "DBClusterSnapshotIdentifier": "mydbclustersnapshot", - "DBClusterIdentifier": "mydbcluster", - "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", - "Engine": "aurora-mysql", - "AllocatedStorage": 1, - "Status": "creating", - "Port": 0, - "VpcId": "vpc-6594f31c", - "ClusterCreateTime": "2019-04-15T14:18:42.785Z", - "MasterUsername": "myadmin", - "EngineVersion": "5.7.mysql_aurora.2.04.2", - "LicenseModel": "aurora-mysql", - "SnapshotType": "manual", - "PercentProgress": 0, - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", - "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", - "IAMDatabaseAuthenticationEnabled": false - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1-snapshot1\n

", - "smithy.api#required": {} - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
\n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the DB cluster snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBClusterSnapshotResult": { - "type": "structure", - "members": { - "DBClusterSnapshot": { - "target": "com.amazonaws.rds#DBClusterSnapshot" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#CertificateNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB instance.

\n

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

\n

For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

\n

For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

", - "smithy.api#examples": [ - { - "title": "To create a DB instance", - "documentation": "The following example uses the required options to launch a new DB instance.", - "input": { - "DBInstanceIdentifier": "test-mysql-instance", - "AllocatedStorage": 20, - "DBInstanceClass": "db.t3.micro", - "Engine": "mysql", - "MasterUsername": "admin", - "MasterUserPassword": "secret99" - }, - "output": { - "DBInstance": { - "DBInstanceIdentifier": "test-mysql-instance", - "DBInstanceClass": "db.t3.micro", - "Engine": "mysql", - "DBInstanceStatus": "creating", - "MasterUsername": "admin", - "AllocatedStorage": 20, - "PreferredBackupWindow": "12:55-13:25", - "BackupRetentionPeriod": 1, - "DBSecurityGroups": [], - "VpcSecurityGroups": [ - { - "VpcSecurityGroupId": "sg-12345abc", - "Status": "active" - } - ], - "DBParameterGroups": [ - { - "DBParameterGroupName": "default.mysql5.7", - "ParameterApplyStatus": "in-sync" - } - ], - "DBSubnetGroup": { - "DBSubnetGroupName": "default", - "DBSubnetGroupDescription": "default", - "VpcId": "vpc-2ff2ff2f", - "SubnetGroupStatus": "Complete", - "Subnets": [ - { - "SubnetIdentifier": "subnet-########", - "SubnetAvailabilityZone": { - "Name": "us-west-2c" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-########", - "SubnetAvailabilityZone": { - "Name": "us-west-2d" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-########", - "SubnetAvailabilityZone": { - "Name": "us-west-2a" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-########", - "SubnetAvailabilityZone": { - "Name": "us-west-2b" - }, - "SubnetStatus": "Active" - } - ] - }, - "PreferredMaintenanceWindow": "sun:08:07-sun:08:37", - "PendingModifiedValues": { - "MasterUserPassword": "****" - }, - "MultiAZ": false, - "EngineVersion": "5.7.22", - "AutoMinorVersionUpgrade": true, - "ReadReplicaDBInstanceIdentifiers": [], - "LicenseModel": "general-public-license", - "OptionGroupMemberships": [ - { - "OptionGroupName": "default:mysql-5-7", - "Status": "in-sync" - } - ], - "PubliclyAccessible": true, - "StorageType": "gp2", - "DbInstancePort": 0, - "StorageEncrypted": false, - "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE", - "CACertificateIdentifier": "rds-ca-2019", - "DomainMemberships": [], - "CopyTagsToSnapshot": false, - "MonitoringInterval": 0, - "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance", - "IAMDatabaseAuthenticationEnabled": false, - "PerformanceInsightsEnabled": false, - "DeletionProtection": false, - "AssociatedRoles": [] - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBInstanceMessage": { - "type": "structure", - "members": { - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \n
\n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \n
\n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \n
\n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters

    \n
    • \n
\n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 8 alphanumeric characters.

    \n
    • \n
  • \n

    It must contain a letter.

    \n
    • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
    • \n
\n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 64 alphanumeric characters.

    \n
    • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
    • \n
\n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
    • \n
  • \n

    It must begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
    • \n
  • \n

    It can't be a word reserved by the\n database engine.

    \n
    • \n
" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for this DB instance. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

", - "smithy.api#required": {} - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n
\n
Amazon RDS Custom
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
\n
\n
RDS for MariaDB
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for MySQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for Oracle
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n
\n
RDS for PostgreSQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for SQL Server
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \n
    • \n
\n
\n
" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

", - "smithy.api#required": {} - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for this DB instance.

\n

Not every database engine is available in every Amazon Web Services Region.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql (for Aurora MySQL DB instances)

    \n
    • \n
  • \n

    \n aurora-postgresql (for Aurora PostgreSQL DB instances)

    \n
    • \n
  • \n

    \n custom-oracle-ee (for RDS Custom for Oracle DB instances)

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.

\n

This setting is required for RDS DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters, numbers, or underscores.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
    • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
    • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
    • \n
" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

This setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Constraints:

\n
    \n
  • \n

    The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.

    \n
    • \n
  • \n

    The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

    \n
    • \n
\n

Example: us-east-1d\n

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB subnet group.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur. \n For more information, see Amazon RDS Maintenance Window \n in the Amazon RDS User Guide.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    The day values must be mon | tue | wed | thu | fri | sat | sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then \n Amazon RDS uses the default DB parameter group for the specified DB engine and version.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas.

    \n
    • \n
  • \n

    Can't be set to 0 for an RDS Custom for Oracle DB instance.

    \n
    • \n
" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    RDS for MariaDB - 3306\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - 1433\n

    \n
    • \n
  • \n

    RDS for MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for Oracle - 1521\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - 5432\n

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    For RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.

    \n
    • \n
" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n
\n
Amazon RDS Custom for Oracle
\n
\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n
\n
Amazon RDS Custom for SQL Server
\n
\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n
\n
RDS for MariaDB
\n
\n

For information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Microsoft SQL Server
\n
\n

For information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.

\n
\n
RDS for MySQL
\n
\n

For information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Oracle
\n
\n

For information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.

\n
\n
RDS for PostgreSQL
\n
\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n
\n
" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model information for this DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
    • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
    • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
    • \n
" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 \n of the storage amount for the DB instance.

    \n
    • \n
  • \n

    For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.

    \n
    • \n
" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group to associate the DB instance with.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

For supported engines, the character set (CharacterSet) to associate the DB instance with.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora - The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

    \n
    • \n
  • \n

    RDS Custom - However, if you need to change the character set, \n you can change it on the database itself.

    \n
    • \n
" - } - }, - "NcharCharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.

    \n
    • \n
" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB instance.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster that this DB instance will belong to.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" - } - }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifes whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.

\n

This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL \n Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The domain is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" - } - }, - "DomainFqdn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" - } - }, - "DomainOu": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" - } - }, - "DomainAuthSecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" - } - }, - "DomainDnsIps": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The domain is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: 1\n

\n

Valid Values: 0 - 15\n

" - } - }, - "Timezone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    RDS for MariaDB - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - agent | error\n

    \n
    • \n
  • \n

    RDS for MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for Oracle - alert | audit | listener | trace | oemagent\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (Storage is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance.

\n

This setting is required for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The location for storing automated backups and manual snapshots.

\n

Valie Values:

\n
    \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
    • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
    • \n
\n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. In this context, the term \"Oracle database instance\" refers exclusively \n to the system global area (SGA) and Oracle background processes. If you don't specify a SID, \n the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBInstanceReadReplica": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotAllowedFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.

\n

All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

\n ", - "smithy.api#examples": [ - { - "title": "To create a DB instance read replica", - "documentation": "This example creates a read replica of an existing DB instance named test-instance. The read replica is named test-instance-repl.", - "input": { - "DBInstanceIdentifier": "test-instance-repl", - "SourceDBInstanceIdentifier": "test-instance" - }, - "output": { - "DBInstance": { - "IAMDatabaseAuthenticationEnabled": false, - "MonitoringInterval": 0, - "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", - "ReadReplicaSourceDBInstanceIdentifier": "test-instance", - "DBInstanceIdentifier": "test-instance-repl" - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier of the read replica. This identifier is the unique key\n that identifies a DB instance. This parameter is stored as a lowercase string.

", - "smithy.api#required": {} - } - }, - "SourceDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL\n Server, which can have up to five.

\n

Constraints:

\n
    \n
  • \n

    Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.

    \n
    • \n
  • \n

    Can't be specified if the SourceDBClusterIdentifier parameter is\n also specified.

    \n
    • \n
  • \n

    For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the\n Amazon RDS User Guide.

    \n
    • \n
  • \n

    For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.

    \n
    • \n
  • \n

    The specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.

    \n
    • \n
  • \n

    If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.

    \n
    • \n
  • \n

    If the source DB instance is in a different Amazon Web Services Region from the read\n replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User\n Guide. This doesn't apply to SQL Server or RDS Custom, which\n don't support cross-Region replicas.

    \n
    • \n
" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: Inherits from the source DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the read replica is in a Multi-AZ deployment.

\n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Inherits from the source DB instance

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group the DB instance is associated with. If omitted, the option group\n associated with the source instance or cluster is used.

\n \n

For SQL Server, you must use the option group associated with the source.

\n \n

This setting doesn't apply to RDS Custom.

" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBSubnetGroup.

    \n
    • \n
  • \n

    The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

    \n
    • \n
  • \n

    All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>

    \n
      \n
    • \n

      Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

      \n
      • \n
    • \n

      Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

      \n
      • \n
    \n
    • \n
\n

Example: mydbsubnetgroup\n

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the read replica.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted read replica.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read\n replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source\n DB instance or cluster.

\n

If you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance or\n Multi-AZ DB cluster.

\n

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

This setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.

    \n

    For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.

    \n
    • \n
  • \n

    \n SourceDBInstanceIdentifier - The DB instance identifier for the\n encrypted DB instance to be replicated. This identifier must be in the Amazon\n Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are\n creating an encrypted read replica from a DB instance in the us-west-2\n Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory\n Service.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DomainFqdn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" - } - }, - "DomainOu": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" - } - }, - "DomainAuthSecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" - } - }, - "DomainDnsIps": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" - } - }, - "ReplicaMode": { - "target": "com.amazonaws.rds#ReplicaMode", - "traits": { - "smithy.api#documentation": "

The open mode of the replica database: mounted or read-only.

\n \n

This parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the read replica.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough storage for your read replica so that the create operation can succeed.\n You can also allocate additional storage for future growth.

\n " - } - }, - "SourceDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the Multi-AZ DB cluster that will act as the source for the read\n replica. Each DB cluster can have up to 15 read replicas.

\n

Constraints:

\n
    \n
  • \n

    Must be the identifier of an existing Multi-AZ DB cluster.

    \n
    • \n
  • \n

    Can't be specified if the SourceDBInstanceIdentifier parameter is\n also specified.

    \n
    • \n
  • \n

    The specified DB cluster must have automatic backups enabled, that is, its\n backup retention period must be greater than 0.

    \n
    • \n
  • \n

    The source DB cluster must be in the same Amazon Web Services Region as the read replica.\n Cross-Region replication isn't supported.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBInstanceReadReplicaResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBParameterGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB parameter group.

\n

A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.

\n

This command doesn't apply to RDS Custom.

\n \n

After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n ", - "smithy.api#examples": [ - { - "title": "To create a DB parameter group", - "documentation": "The following example creates a DB parameter group.", - "input": { - "DBParameterGroupName": "mydbparametergroup", - "DBParameterGroupFamily": "MySQL8.0", - "Description": "My new parameter group" - }, - "output": { - "DBParameterGroup": { - "DBParameterGroupName": "mydbparametergroup", - "DBParameterGroupFamily": "mysql8.0", - "Description": "My new parameter group", - "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup" - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBParameterGroupMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n ", - "smithy.api#required": {} - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB parameter group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBParameterGroupResult": { - "type": "structure", - "members": { - "DBParameterGroup": { - "target": "com.amazonaws.rds#DBParameterGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBProxy": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBProxyRequest" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBProxyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBProxyQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB proxy.

" - } - }, - "com.amazonaws.rds#CreateDBProxyEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBProxyEndpointRequest" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBProxyEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters.\n You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use\n DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

" - } - }, - "com.amazonaws.rds#CreateDBProxyEndpointRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#DBProxyName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy associated with the DB proxy endpoint that you create.

", - "smithy.api#required": {} - } - }, - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy endpoint to create.

", - "smithy.api#required": {} - } - }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a\n different set of subnet IDs than for the original DB proxy.

", - "smithy.api#required": {} - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint that you create. You can\n specify a different set of security group IDs than for the original DB proxy.\n The default is the default security group for the VPC.

" - } - }, - "TargetRole": { - "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBProxyEndpointResponse": { - "type": "structure", - "members": { - "DBProxyEndpoint": { - "target": "com.amazonaws.rds#DBProxyEndpoint", - "traits": { - "smithy.api#documentation": "

The DBProxyEndpoint object that is created by the API operation.\n The DB proxy endpoint that you create might provide capabilities such as read/write\n or read-only operations, or using a different VPC than the proxy's default VPC.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBProxyRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

", - "smithy.api#required": {} - } - }, - "EngineFamily": { - "target": "com.amazonaws.rds#EngineFamily", - "traits": { - "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. \n For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify \n SQLSERVER.

", - "smithy.api#required": {} - } - }, - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigList", - "traits": { - "smithy.api#documentation": "

The authorization mechanism that the proxy uses.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

", - "smithy.api#required": {} - } - }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more VPC subnet IDs to associate with the new proxy.

", - "smithy.api#required": {} - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more VPC security group IDs to associate with the new proxy.

" - } - }, - "RequireTLS": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

" - } - }, - "IdleClientTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" - } - }, - "DebugLogging": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBProxyResponse": { - "type": "structure", - "members": { - "DBProxy": { - "target": "com.amazonaws.rds#DBProxy", - "traits": { - "smithy.api#documentation": "

The DBProxy structure corresponding to the new proxy.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBSecurityGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBSecurityGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBSecurityGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotSupportedFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", - "smithy.api#examples": [ - { - "title": "To create a DB security group.", - "documentation": "This example creates a DB security group.", - "input": { - "DBSecurityGroupName": "mydbsecuritygroup", - "DBSecurityGroupDescription": "My DB security group" - }, - "output": { - "DBSecurityGroup": {} - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBSecurityGroupMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the DB security group. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \n
\n

Example: mysecuritygroup\n

", - "smithy.api#required": {} - } - }, - "DBSecurityGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB security group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBSecurityGroupResult": { - "type": "structure", - "members": { - "DBSecurityGroup": { - "target": "com.amazonaws.rds#DBSecurityGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.

", - "smithy.api#examples": [ - { - "title": "To create a DB snapshot", - "documentation": "The following example creates a DB snapshot.", - "input": { - "DBSnapshotIdentifier": "database-mysql", - "DBInstanceIdentifier": "mydbsnapshot" - }, - "output": { - "DBSnapshot": { - "DBSnapshotIdentifier": "mydbsnapshot", - "DBInstanceIdentifier": "database-mysql", - "Engine": "mysql", - "AllocatedStorage": 100, - "Status": "creating", - "Port": 3306, - "AvailabilityZone": "us-east-1b", - "VpcId": "vpc-6594f31c", - "InstanceCreateTime": "2019-04-30T15:45:53.663Z", - "MasterUsername": "admin", - "EngineVersion": "8.0.32", - "LicenseModel": "general-public-license", - "SnapshotType": "manual", - "Iops": 1000, - "OptionGroupName": "default:mysql-8-0", - "PercentProgress": 0, - "StorageType": "io1", - "Encrypted": true, - "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", - "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", - "IAMDatabaseAuthenticationEnabled": false, - "ProcessorFeatures": [], - "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBSnapshotMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

", - "smithy.api#required": {} - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB instance that you want to create the snapshot of.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBSnapshotResult": { - "type": "structure", - "members": { - "DBSnapshot": { - "target": "com.amazonaws.rds#DBSnapshot" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateDBSubnetGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBSubnetGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBSubnetGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

", - "smithy.api#examples": [ - { - "title": "To create a DB subnet group", - "documentation": "The following example creates a DB subnet group called mysubnetgroup using existing subnets.", - "input": { - "DBSubnetGroupName": "mysubnetgroup", - "DBSubnetGroupDescription": "test DB subnet group", - "SubnetIds": [ - "subnet-0a1dc4e1a6f123456", - "subnet-070dd7ecb3aaaaaaa", - "subnet-00f5b198bc0abcdef" - ] - }, - "output": { - "DBSubnetGroup": { - "DBSubnetGroupName": "mysubnetgroup", - "DBSubnetGroupDescription": "test DB subnet group", - "VpcId": "vpc-0f08e7610a1b2c3d4", - "SubnetGroupStatus": "Complete", - "Subnets": [ - { - "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", - "SubnetAvailabilityZone": { - "Name": "us-west-2b" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-00f5b198bc0abcdef", - "SubnetAvailabilityZone": { - "Name": "us-west-2d" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", - "SubnetAvailabilityZone": { - "Name": "us-west-2b" - }, - "SubnetStatus": "Active" - } - ], - "DBSubnetGroupArn": "arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup" - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateDBSubnetGroupMessage": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

", - "smithy.api#required": {} - } - }, - "DBSubnetGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB subnet group.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.rds#SubnetIdentifierList", - "traits": { - "smithy.api#documentation": "

The EC2 Subnet IDs for the DB subnet group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB subnet group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateDBSubnetGroupResult": { - "type": "structure", - "members": { - "DBSubnetGroup": { - "target": "com.amazonaws.rds#DBSubnetGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateEventSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateEventSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateEventSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#SNSInvalidTopicFault" - }, - { - "target": "com.amazonaws.rds#SNSNoAuthorizationFault" - }, - { - "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SourceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionAlreadyExistFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n

For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

\n

For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

", - "smithy.api#examples": [ - { - "title": "To create an event subscription", - "documentation": "The following example creates a subscription for backup and recovery events for DB instances in the current AWS account. Notifications are sent to an Amazon Simple Notification Service topic.", - "input": { - "SubscriptionName": "my-instance-events", - "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", - "SourceType": "db-instance", - "EventCategories": [ - "backup", - "recovery" - ] - }, - "output": { - "EventSubscription": { - "Status": "creating", - "CustSubscriptionId": "my-instance-events", - "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", - "EventCategoriesList": [ - "backup", - "recovery" - ], - "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", - "CustomerAwsId": "123456789012", - "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", - "SourceType": "db-instance", - "Enabled": true - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateEventSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", - "smithy.api#required": {} - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

", - "smithy.api#required": {} - } - }, - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .\n You can also see this list by using the DescribeEventCategories operation.

" - } - }, - "SourceIds": { - "target": "com.amazonaws.rds#SourceIdsList", - "traits": { - "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

\n

Constraints:

\n
    \n
  • \n

    If SourceIds are supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
" - } - }, - "Enabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateEventSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

\n

You can create a global database that is initially empty, and then \n create the primary and secondary DB clusters in the global database.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

\n \n

This operation applies only to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To create a global DB cluster", - "documentation": "The following example creates a new Aurora MySQL-compatible global DB cluster.", - "input": { - "GlobalClusterIdentifier": "myglobalcluster", - "Engine": "aurora-mysql" - }, - "output": { - "GlobalCluster": { - "GlobalClusterIdentifier": "myglobalcluster", - "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", - "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", - "Status": "available", - "Engine": "aurora-mysql", - "EngineVersion": "5.7.mysql_aurora.2.07.2", - "StorageEncrypted": false, - "DeletionProtection": false, - "GlobalClusterMembers": [] - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

" - } - }, - "SourceDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

\n

If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

\n
    \n
  • \n

    \n DatabaseName\n

    \n
    • \n
  • \n

    \n Engine\n

    \n
    • \n
  • \n

    \n EngineVersion\n

    \n
    • \n
  • \n

    \n StorageEncrypted\n

    \n
    • \n
" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for this global database cluster.

\n

Valid Values: aurora-mysql | aurora-postgresql\n

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

    \n
    • \n
" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version to use for this global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

    \n
    • \n
" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable deletion protection for the new global database cluster.\n The global database can't be deleted when deletion protection is enabled.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you don't specify\n a name, Amazon Aurora doesn't create a database in the global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.

    \n
    • \n
" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable storage encryption for the new global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CreateOptionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateOptionGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateOptionGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new option group. You can create up to 20 option groups.

\n

This command doesn't apply to RDS Custom.

", - "smithy.api#examples": [ - { - "title": "To Create an Amazon RDS option group", - "documentation": "The following example creates a new Amazon RDS option group for Oracle MySQL version 8,0 named MyOptionGroup.", - "input": { - "OptionGroupName": "MyOptionGroup", - "EngineName": "mysql", - "MajorEngineVersion": "8.0", - "OptionGroupDescription": "MySQL 8.0 option group" - }, - "output": { - "OptionGroup": { - "OptionGroupName": "myoptiongroup", - "OptionGroupDescription": "MySQL 8.0 option group", - "EngineName": "mysql", - "MajorEngineVersion": "8.0", - "Options": [], - "AllowsVpcAndNonVpcInstanceMemberships": true, - "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" - } - } - } - ] - } - }, - "com.amazonaws.rds#CreateOptionGroupMessage": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the option group to be created.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: myoptiongroup\n

", - "smithy.api#required": {} - } - }, - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the major version of the engine that this option group should be associated with.

", - "smithy.api#required": {} - } - }, - "OptionGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#CreateOptionGroupResult": { - "type": "structure", - "members": { - "OptionGroup": { - "target": "com.amazonaws.rds#OptionGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomAvailabilityZoneNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n CustomAvailabilityZoneId doesn't refer to an existing custom\n Availability Zone identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#CustomDBEngineVersionAMI": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates the ID of the AMI.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates the status of a custom engine version (CEV).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A value that indicates the AMI information.

" - } - }, - "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomDBEngineVersionAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A CEV with the specified name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#CustomDBEngineVersionManifest": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 51000 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomDBEngineVersionNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified CEV was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomDBEngineVersionQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have exceeded your CEV quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#CustomEngineName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 35 - }, - "smithy.api#pattern": "^[A-Za-z0-9-]{1,35}$" - } - }, - "com.amazonaws.rds#CustomEngineVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "^[a-z0-9_.-]{1,60}$" - } - }, - "com.amazonaws.rds#CustomEngineVersionStatus": { - "type": "enum", - "members": { - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inactive" - } - }, - "inactive_except_restore": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inactive-except-restore" - } - } - } - }, - "com.amazonaws.rds#DBCluster": { - "type": "structure", - "members": { - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If present, specifies the name of the character set that this cluster is associated with.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

" - } - }, - "DBClusterParameterGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group for the DB cluster.

" - } - }, - "DBSubnetGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The current state of this DB cluster.

" - } - }, - "AutomaticRestartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when a stopped DB cluster is restarted automatically.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The progress of the operation as a percentage.

" - } - }, - "EarliestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The earliest time to which a database can be restored with point-in-time\n restore.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The connection endpoint for the primary instance of the DB cluster.

" - } - }, - "ReaderEndpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

\n

If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

" - } - }, - "CustomEndpoints": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The custom endpoints associated with the DB cluster.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether the DB cluster has instances in multiple Availability Zones.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine used for this DB cluster.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine.

" - } - }, - "LatestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The latest time to which a database can be restored with point-in-time restore.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port that the database engine is listening on.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The master username for the DB cluster.

" - } - }, - "DBClusterOptionGroupMemberships": { - "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", - "traits": { - "smithy.api#documentation": "

The list of option group memberships for this DB cluster.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" - } - }, - "ReplicationSourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the source DB cluster if this DB cluster is a read\n replica.

" - } - }, - "ReadReplicaIdentifiers": { - "target": "com.amazonaws.rds#ReadReplicaIdentifierList", - "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n cluster.

" - } - }, - "DBClusterMembers": { - "target": "com.amazonaws.rds#DBClusterMemberList", - "traits": { - "smithy.api#documentation": "

The list of DB instances that make up the DB cluster.

" - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

The list of VPC security groups that the DB cluster belongs to.

" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigns when you create a hosted zone.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the DB cluster is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "DbClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever \n the KMS key for the DB cluster is accessed.

" - } - }, - "DBClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster.

" - } - }, - "AssociatedRoles": { - "target": "com.amazonaws.rds#DBClusterRoles", - "traits": { - "smithy.api#documentation": "

A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" - } - }, - "CloneGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the clone group with which the DB cluster is associated.

" - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" - } - }, - "EarliestBacktrackTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The earliest time to which a DB cluster can be backtracked.

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

" - } - }, - "BacktrackConsumedChangeRecords": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The number of change records stored for Backtrack.

" - } - }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

" - } - }, - "Capacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

For more information, see \n CreateDBCluster.

" - } - }, - "ScalingConfigurationInfo": { - "target": "com.amazonaws.rds#ScalingConfigurationInfo" - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.

" - } - }, - "HttpEndpointEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" - } - }, - "ActivityStreamMode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

" - } - }, - "ActivityStreamStatus": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream.

" - } - }, - "ActivityStreamKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "ActivityStreamKinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

" - } - }, - "CrossAccountClone": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

" - } - }, - "DomainMemberships": { - "target": "com.amazonaws.rds#DomainMembershipList", - "traits": { - "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB cluster.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "GlobalWriteForwardingStatus": { - "target": "com.amazonaws.rds#WriteForwardingStatus", - "traits": { - "smithy.api#documentation": "

The status of write forwarding for a secondary cluster in an Aurora global database.

" - } - }, - "GlobalWriteForwardingRequested": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" - } - }, - "PendingModifiedValues": { - "target": "com.amazonaws.rds#ClusterPendingModifiedValues", - "traits": { - "smithy.api#documentation": "

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type associated with the DB cluster.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBCluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "PerformanceInsightsEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

\n

Valid Values: IPV4 | DUAL\n

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - }, - "MasterUserSecret": { - "target": "com.amazonaws.rds#MasterUserSecret", - "traits": { - "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" - } - }, - "IOOptimizedNextAllowedModificationTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

\n

This setting is only for Aurora DB clusters.

" - } - }, - "LocalWriteForwardingStatus": { - "target": "com.amazonaws.rds#LocalWriteForwardingStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#DBClusterAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The user already has a DB cluster with the given identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterAutomatedBackup": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine for this automated backup.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The VPC ID associated with the DB cluster.

" - } - }, - "DBClusterAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the automated backups.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "RestoreWindow": { - "target": "com.amazonaws.rds#RestoreWindow" - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The master user name of the automated backup.

" - } - }, - "DbClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "Region": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model information for this DB cluster automated backup.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A list of status information for an automated backup:

\n
    \n
  • \n

    \n retained - Automated backups for deleted clusters.

    \n
    • \n
" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and \n otherwise false.

" - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the source DB cluster is encrypted.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine for the automated backup.

" - } - }, - "DBClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the source DB cluster.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The retention period for the automated backups.

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine mode of the database engine for the automated backup.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

The Availability Zones where instances in the DB cluster can be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB cluster

\n

Valid Values: 1150-65535\n

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type associated with the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster \n properties that existed at the time you deleted the source cluster.

" - } - }, - "com.amazonaws.rds#DBClusterAutomatedBackupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterAutomatedBackup", - "traits": { - "smithy.api#xmlName": "DBClusterAutomatedBackup" - } - } - }, - "com.amazonaws.rds#DBClusterAutomatedBackupMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.

" - } - }, - "DBClusterAutomatedBackups": { - "target": "com.amazonaws.rds#DBClusterAutomatedBackupList", - "traits": { - "smithy.api#documentation": "

A list of DBClusterAutomatedBackup backups.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterAutomatedBackupNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

No automated backup for this DB cluster was found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterAutomatedBackupQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated \n backups. The retained automated backups quota is the same as your DB cluster quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterBacktrack": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" - } - }, - "BacktrackIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the backtrack identifier.

" - } - }, - "BacktrackTo": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the time to which the DB cluster was backtracked.

" - } - }, - "BacktrackedFrom": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the time from which the DB cluster was backtracked.

" - } - }, - "BacktrackRequestCreationTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the time at which the backtrack was requested.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the backtrack. This property returns one of the following\n values:

\n
    \n
  • \n

    \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBClusterBacktracks action.

" - } - }, - "com.amazonaws.rds#DBClusterBacktrackList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterBacktrack", - "traits": { - "smithy.api#xmlName": "DBClusterBacktrack" - } - } - }, - "com.amazonaws.rds#DBClusterBacktrackMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusterBacktracks request.

" - } - }, - "DBClusterBacktracks": { - "target": "com.amazonaws.rds#DBClusterBacktrackList", - "traits": { - "smithy.api#documentation": "

Contains a list of backtracks for the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBClusterBacktrackNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterBacktrackNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n BacktrackIdentifier doesn't refer to an existing backtrack.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterCapacityInfo": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" - } - }, - "PendingCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

A value that specifies the capacity that the DB cluster scales to next.

" - } - }, - "CurrentCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The current capacity of the DB cluster.

" - } - }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

" - } - }, - "TimeoutAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.

" - } - } - } - }, - "com.amazonaws.rds#DBClusterEndpoint": { - "type": "structure", - "members": { - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" - } - }, - "DBClusterEndpointResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DNS address of the endpoint.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster,\n such as a writer endpoint for a read-only secondary cluster in a global database.

" - } - }, - "EndpointType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, CUSTOM.

" - } - }, - "CustomEndpointType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type associated with a custom endpoint. One of: READER,\n WRITER, ANY.

" - } - }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" - } - }, - "ExcludedMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" - } - }, - "DBClusterEndpointArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the endpoint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n ModifyDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DeleteDBClusterEndpoint\n

    \n
    • \n
\n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" - } - }, - "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterEndpointAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified custom endpoint can't be created because it already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterEndpointList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterEndpoint", - "traits": { - "smithy.api#xmlName": "DBClusterEndpointList" - } - } - }, - "com.amazonaws.rds#DBClusterEndpointMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBClusterEndpoints": { - "target": "com.amazonaws.rds#DBClusterEndpointList", - "traits": { - "smithy.api#documentation": "

Contains the details of the endpoints associated with the cluster\n and matching any filter conditions.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBClusterEndpointNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterEndpointNotFoundFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified custom endpoint doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterEndpointQuotaExceededFault", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

The cluster already has the maximum number of custom endpoints.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.rds#DBClusterIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" - } - }, - "com.amazonaws.rds#DBClusterList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBCluster", - "traits": { - "smithy.api#xmlName": "DBCluster" - } - } - }, - "com.amazonaws.rds#DBClusterMember": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the instance identifier for this member of the DB cluster.

" - } - }, - "IsClusterWriter": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

" - } - }, - "DBClusterParameterGroupStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an instance that is part of a DB cluster.

" - } - }, - "com.amazonaws.rds#DBClusterMemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterMember", - "traits": { - "smithy.api#xmlName": "DBClusterMember" - } - } - }, - "com.amazonaws.rds#DBClusterMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusters request.

" - } - }, - "DBClusters": { - "target": "com.amazonaws.rds#DBClusterList", - "traits": { - "smithy.api#documentation": "

Contains a list of DB clusters for the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusters action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBClusterNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterOptionGroupMemberships": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterOptionGroupStatus", - "traits": { - "smithy.api#xmlName": "DBClusterOptionGroup" - } - } - }, - "com.amazonaws.rds#DBClusterOptionGroupStatus": { - "type": "structure", - "members": { - "DBClusterOptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the DB cluster option group.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of the DB cluster option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains status information for a DB cluster option group.

" - } - }, - "com.amazonaws.rds#DBClusterParameterGroup": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family that this DB cluster parameter group is compatible with.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the customer-specified description for this DB cluster parameter group.

" - } - }, - "DBClusterParameterGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB cluster parameter group.

\n

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

" - } - }, - "com.amazonaws.rds#DBClusterParameterGroupDetails": { - "type": "structure", - "members": { - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

Provides a list of parameters for the DB cluster parameter group.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

" - } - }, - "com.amazonaws.rds#DBClusterParameterGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterParameterGroup", - "traits": { - "smithy.api#xmlName": "DBClusterParameterGroup" - } - } - }, - "com.amazonaws.rds#DBClusterParameterGroupNameMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterParameterGroupNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterParameterGroupsMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBClusterParameterGroups": { - "target": "com.amazonaws.rds#DBClusterParameterGroupList", - "traits": { - "smithy.api#documentation": "

A list of DB cluster parameter groups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBClusterQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterQuotaExceededFault", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

The user attempted to create a new DB cluster and the user has already reached the\n maximum allowed DB cluster quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.rds#DBClusterRole": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other Amazon Web Services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB cluster.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other Amazon Web Services on your behalf.

    \n
    • \n
" - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

" - } - }, - "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterRoleAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterRoleNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterRoleNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterRoleQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterRoleQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterRoles": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterRole", - "traits": { - "smithy.api#xmlName": "DBClusterRole" - } - } - }, - "com.amazonaws.rds#DBClusterSnapshot": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

" - } - }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the identifier for the DB cluster snapshot.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" - } - }, - "SnapshotCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the database engine for this DB cluster snapshot.

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the engine mode of the database engine for this DB cluster snapshot.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

\n
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n copying\n

    \n
    • \n
  • \n

    \n creating\n

    \n
    • \n
" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB cluster snapshot.

" - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the master username for this DB cluster snapshot.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the version of the database engine for this DB cluster snapshot.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the license model information for this DB cluster snapshot.

" - } - }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the type of the DB cluster snapshot.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB cluster snapshot is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "DBClusterSnapshotArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.

" - } - }, - "SourceDBClusterSnapshotArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type associated with the DB cluster snapshot.

\n

This setting is only for Aurora DB clusters.

" - } - }, - "DbClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details for an Amazon RDS DB cluster snapshot

\n

This data type is used as a response element \n in the DescribeDBClusterSnapshots action.

" - } - }, - "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterSnapshotAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The user already has a DB cluster snapshot with the given identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterSnapshotAttribute": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.

" - } - }, - "AttributeValues": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

The value(s) for the manual DB cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the name and values of a manual DB cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" - } - }, - "com.amazonaws.rds#DBClusterSnapshotAttributeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterSnapshotAttribute", - "traits": { - "smithy.api#xmlName": "DBClusterSnapshotAttribute" - } - } - }, - "com.amazonaws.rds#DBClusterSnapshotAttributesResult": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the manual DB cluster snapshot that the attributes apply to.

" - } - }, - "DBClusterSnapshotAttributes": { - "target": "com.amazonaws.rds#DBClusterSnapshotAttributeList", - "traits": { - "smithy.api#documentation": "

The list of attributes and values for the manual DB cluster snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" - } - }, - "com.amazonaws.rds#DBClusterSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterSnapshot", - "traits": { - "smithy.api#xmlName": "DBClusterSnapshot" - } - } - }, - "com.amazonaws.rds#DBClusterSnapshotMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBClusterSnapshots": { - "target": "com.amazonaws.rds#DBClusterSnapshotList", - "traits": { - "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBClusterSnapshotNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterSnapshotNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBEngineVersion": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine.

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family for the database engine.

" - } - }, - "DBEngineDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the database engine.

" - } - }, - "DBEngineVersionDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the database engine version.

" - } - }, - "DefaultCharacterSet": { - "target": "com.amazonaws.rds#CharacterSet", - "traits": { - "smithy.api#documentation": "

The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.

" - } - }, - "Image": { - "target": "com.amazonaws.rds#CustomDBEngineVersionAMI", - "traits": { - "smithy.api#documentation": "

The EC2 image

" - } - }, - "DBEngineMediaType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

" - } - }, - "SupportedCharacterSets": { - "target": "com.amazonaws.rds#SupportedCharacterSetsList", - "traits": { - "smithy.api#documentation": "

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

" - } - }, - "SupportedNcharCharacterSets": { - "target": "com.amazonaws.rds#SupportedCharacterSetsList", - "traits": { - "smithy.api#documentation": "

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

" - } - }, - "ValidUpgradeTarget": { - "target": "com.amazonaws.rds#ValidUpgradeTargetList", - "traits": { - "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" - } - }, - "SupportedTimezones": { - "target": "com.amazonaws.rds#SupportedTimezonesList", - "traits": { - "smithy.api#documentation": "

A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action.

" - } - }, - "ExportableLogTypes": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The types of logs that the database engine has available for export to CloudWatch Logs.

" - } - }, - "SupportsLogExportsToCloudwatchLogs": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" - } - }, - "SupportsReadReplica": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the database engine version supports read replicas.

" - } - }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", - "traits": { - "smithy.api#documentation": "

A list of the supported DB engine modes.

" - } - }, - "SupportedFeatureNames": { - "target": "com.amazonaws.rds#FeatureNameList", - "traits": { - "smithy.api#documentation": "

A list of features supported by the DB engine.

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the DB engine version, either available or deprecated.

" - } - }, - "SupportsParallelQuery": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

" - } - }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

" - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The major engine version of the CEV.

" - } - }, - "DatabaseInstallationFilesS3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains your database installation files.

" - } - }, - "DatabaseInstallationFilesS3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files. \n If not specified, then no prefix is assumed.

" - } - }, - "DBEngineVersionArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN of the custom engine version.

" - } - }, - "KMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for \n RDS Custom, but optional for Amazon RDS.

" - } - }, - "CreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The creation time of the DB engine version.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "SupportsBabelfish": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

" - } - }, - "CustomDBEngineVersionManifest": { - "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", - "traits": { - "smithy.api#documentation": "

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). \n RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, \n and UNIX/Linux user and group using the installation parameters. For more information, \n see JSON fields in the CEV manifest in the Amazon RDS User Guide.\n

" - } - }, - "SupportsCertificateRotationWithoutRestart": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.

" - } - }, - "SupportedCACertificateIdentifiers": { - "target": "com.amazonaws.rds#CACertificateIdentifiersList", - "traits": { - "smithy.api#documentation": "

A list of the supported CA certificate identifiers.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" - } - }, - "SupportsLocalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" - } - }, - "com.amazonaws.rds#DBEngineVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBEngineVersion", - "traits": { - "smithy.api#xmlName": "DBEngineVersion" - } - } - }, - "com.amazonaws.rds#DBEngineVersionMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBEngineVersions": { - "target": "com.amazonaws.rds#DBEngineVersionList", - "traits": { - "smithy.api#documentation": "

A list of DBEngineVersion elements.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBInstance": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine used for this DB instance.

" - } - }, - "DBInstanceStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" - } - }, - "AutomaticRestartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when a stopped DB instance is restarted automatically.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The master username for the DB instance.

" - } - }, - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the initial database name that you provided (if required) when you created\n the DB instance. This name is returned for the life of your DB instance. For an RDS for\n Oracle CDB instance, the name identifies the PDB rather than the CDB.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#Endpoint", - "traits": { - "smithy.api#documentation": "

The connection endpoint for the DB instance.

\n \n

The endpoint might not be shown for instances with the status of creating.

\n " - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) allocated for the DB instance.

" - } - }, - "InstanceCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the DB instance was created.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

" - } - }, - "DBParameterGroups": { - "target": "com.amazonaws.rds#DBParameterGroupStatusList", - "traits": { - "smithy.api#documentation": "

The list of DB parameter groups applied to this DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone where the DB instance is located.

" - } - }, - "DBSubnetGroup": { - "target": "com.amazonaws.rds#DBSubnetGroup", - "traits": { - "smithy.api#documentation": "

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" - } - }, - "PendingModifiedValues": { - "target": "com.amazonaws.rds#PendingModifiedValues", - "traits": { - "smithy.api#documentation": "

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" - } - }, - "LatestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The latest time to which a database in this DB instance can be restored with point-in-time restore.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

" - } - }, - "ReadReplicaSourceDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the source DB instance if this DB instance is a read\n replica.

" - } - }, - "ReadReplicaDBInstanceIdentifiers": { - "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", - "traits": { - "smithy.api#documentation": "

The identifiers of the read replicas associated with this DB\n instance.

" - } - }, - "ReadReplicaDBClusterIdentifiers": { - "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", - "traits": { - "smithy.api#documentation": "

The identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

\n " - } - }, - "ReplicaMode": { - "target": "com.amazonaws.rds#ReplicaMode", - "traits": { - "smithy.api#documentation": "

The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n \n

This attribute is only supported in RDS for Oracle.

\n " - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value for the DB instance.

" - } - }, - "OptionGroupMemberships": { - "target": "com.amazonaws.rds#OptionGroupMembershipList", - "traits": { - "smithy.api#documentation": "

The list of option group memberships for this DB instance.

" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If present, specifies the name of the character set that this instance is associated with.

" - } - }, - "NcharCharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

" - } - }, - "SecondaryAvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "StatusInfos": { - "target": "com.amazonaws.rds#DBInstanceStatusInfoList", - "traits": { - "smithy.api#documentation": "

The status of a read replica. If the DB instance isn't a read replica, the value is\n blank.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type associated with the DB instance.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which the instance is associated for TDE encryption.

" - } - }, - "DbInstancePort": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the DB instance is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log \n entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

" - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" - } - }, - "DomainMemberships": { - "target": "com.amazonaws.rds#DomainMembershipList", - "traits": { - "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB instance.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether tags are copied from the DB instance to snapshots of the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

" - } - }, - "EnhancedMonitoringResourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" - } - }, - "DBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB instance.

" - } - }, - "Timezone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.

\n

For a list of engine versions that support IAM database authentication, see \n IAM database authentication\n in the Amazon RDS User Guide and IAM \n database authentication in Aurora in the Amazon Aurora User Guide.

" - } - }, - "PerformanceInsightsEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB instance.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

" - } - }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Monitoring Amazon RDS log files in the Amazon RDS User Guide.\n

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.

" - } - }, - "AssociatedRoles": { - "target": "com.amazonaws.rds#DBInstanceRoles", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

" - } - }, - "ListenerEndpoint": { - "target": "com.amazonaws.rds#Endpoint", - "traits": { - "smithy.api#documentation": "

The listener connection endpoint for SQL Server Always On.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "DBInstanceAutomatedBackupsReplications": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", - "traits": { - "smithy.api#documentation": "

The list of replicated automated backups associated with the DB instance.

" - } - }, - "CustomerOwnedIpEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "AwsBackupRecoveryPointArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" - } - }, - "ActivityStreamStatus": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream.

" - } - }, - "ActivityStreamKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "ActivityStreamKinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" - } - }, - "ActivityStreamMode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

The mode of the database activity stream. Database events such as a change or access generate \n an activity stream event. RDS for Oracle always handles these events asynchronously.

" - } - }, - "ActivityStreamEngineNativeAuditFieldsIncluded": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" - } - }, - "AutomationMode": { - "target": "com.amazonaws.rds#AutomationMode", - "traits": { - "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" - } - }, - "ResumeFullAutomationModeTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" - } - }, - "ActivityStreamPolicyStatus": { - "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", - "traits": { - "smithy.api#documentation": "

The status of the policy state of the activity stream.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is only valid for RDS Custom DB instances.

" - } - }, - "MasterUserSecret": { - "target": "com.amazonaws.rds#MasterUserSecret", - "traits": { - "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

" - } - }, - "CertificateDetails": { - "target": "com.amazonaws.rds#CertificateDetails", - "traits": { - "smithy.api#documentation": "

The details of the DB instance's server certificate.

" - } - }, - "ReadReplicaSourceDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the source DB cluster if this DB instance is a read\n replica.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The progress of the storage optimization operation as a percentage.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.

\n

This data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.

" - } - }, - "com.amazonaws.rds#DBInstanceAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The user already has a DB instance with the given identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackup": { - "type": "structure", - "members": { - "DBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the automated backups.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "Region": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "RestoreWindow": { - "target": "com.amazonaws.rds#RestoreWindow", - "traits": { - "smithy.api#documentation": "

Earliest and latest time an instance can be restored to.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides a list of status information for an automated backup:

\n
    \n
  • \n

    \n active - Automated backups for current instances.

    \n
    • \n
  • \n

    \n retained - Automated backups for deleted instances.

    \n
    • \n
  • \n

    \n creating - Automated backups that are waiting for the first automated snapshot to be available.

    \n
    • \n
" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone that the automated backup was created in. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB instance.

" - } - }, - "InstanceCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Provides the date and time that the DB instance was created.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The master user name of an automated backup.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine for this automated backup.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine for the automated backup.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for the automated backup.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which the automated backup is associated for TDE encryption.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the automated backup is encrypted.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type associated with the automated backup.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "Timezone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time zone of the automated backup. In most cases, the Timezone element is empty.\n Timezone content appears only for Microsoft SQL Server DB instances \n that were created with a time zone specified.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The retention period for the automated backups.

" - } - }, - "DBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the replicated automated backups.

" - } - }, - "DBInstanceAutomatedBackupsReplications": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", - "traits": { - "smithy.api#documentation": "

The list of replications to different Amazon Web Services Regions associated with the automated backup.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the automated backup.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that\n existed at the time you deleted the source instance.

" - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackup", - "traits": { - "smithy.api#xmlName": "DBInstanceAutomatedBackup" - } - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBInstanceAutomatedBackups": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupList", - "traits": { - "smithy.api#documentation": "

A list of DBInstanceAutomatedBackup instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceAutomatedBackupNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

No automated backup for this DB instance was found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceAutomatedBackupQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB instance quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication": { - "type": "structure", - "members": { - "DBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

" - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication", - "traits": { - "smithy.api#xmlName": "DBInstanceAutomatedBackupsReplication" - } - } - }, - "com.amazonaws.rds#DBInstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstance", - "traits": { - "smithy.api#xmlName": "DBInstance" - } - } - }, - "com.amazonaws.rds#DBInstanceMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - }, - "DBInstances": { - "target": "com.amazonaws.rds#DBInstanceList", - "traits": { - "smithy.api#documentation": "

A list of DBInstance instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstances action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBInstanceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBInstanceRole": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.

" - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB instance.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

" - } - }, - "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceRoleAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified RoleArn or FeatureName value is already associated with the DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBInstanceRoleNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceRoleNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified RoleArn value doesn't match the specified feature for\n the DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceRoleQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBInstanceRoles": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstanceRole", - "traits": { - "smithy.api#xmlName": "DBInstanceRole" - } - } - }, - "com.amazonaws.rds#DBInstanceStatusInfo": { - "type": "structure", - "members": { - "StatusType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

This value is currently \"read replication.\"

" - } - }, - "Normal": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

" - } - }, - "Message": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a list of status information for a DB instance.

" - } - }, - "com.amazonaws.rds#DBInstanceStatusInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstanceStatusInfo", - "traits": { - "smithy.api#xmlName": "DBInstanceStatusInfo" - } - } - }, - "com.amazonaws.rds#DBLogFileNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBLogFileNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n LogFileName doesn't refer to an existing DB log file.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBParameterGroup": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family that this DB parameter group is compatible with.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the customer-specified description for this DB parameter group.

" - } - }, - "DBParameterGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB parameter group.

\n

This data type is used as a response element in the DescribeDBParameterGroups action.

" - } - }, - "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBParameterGroupAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A DB parameter group with the same name exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBParameterGroupDetails": { - "type": "structure", - "members": { - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

A list of Parameter values.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameters action.

" - } - }, - "com.amazonaws.rds#DBParameterGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBParameterGroup", - "traits": { - "smithy.api#xmlName": "DBParameterGroup" - } - } - }, - "com.amazonaws.rds#DBParameterGroupNameMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.

" - } - }, - "com.amazonaws.rds#DBParameterGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBParameterGroupNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBParameterGroupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBParameterGroupQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB parameter\n groups.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBParameterGroupStatus": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

" - } - }, - "ParameterApplyStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of parameter updates.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of the DB parameter group.

\n

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n CreateDBInstanceReadReplica\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
" - } - }, - "com.amazonaws.rds#DBParameterGroupStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBParameterGroupStatus", - "traits": { - "smithy.api#xmlName": "DBParameterGroup" - } - } - }, - "com.amazonaws.rds#DBParameterGroupsMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBParameterGroups": { - "target": "com.amazonaws.rds#DBParameterGroupList", - "traits": { - "smithy.api#documentation": "

A list of DBParameterGroup instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBProxy": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" - } - }, - "DBProxyArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the proxy.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#DBProxyStatus", - "traits": { - "smithy.api#documentation": "

The current status of this proxy. A status of available means the\n proxy is ready to handle requests. Other values indicate that you must wait for\n the proxy to be ready, or take some action to resolve an issue.

" - } - }, - "EngineFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. This value determines which database network protocol \n the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, \n RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. \n SQLSERVER supports RDS for Microsoft SQL Server databases.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID of the DB proxy.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Provides a list of VPC security groups that the proxy belongs to.

" - } - }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The EC2 subnet IDs for the proxy.

" - } - }, - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigInfoList", - "traits": { - "smithy.api#documentation": "

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance\n or Aurora DB cluster.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" - } - }, - "RequireTLS": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

" - } - }, - "IdleClientTimeout": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

\n

Default: 1800 (30 minutes)

\n

Constraints: 1 to 28,800

" - } - }, - "DebugLogging": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the proxy was first created.

" - } - }, - "UpdatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the proxy was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data structure representing a proxy managed by the RDS Proxy.

\n

This data type is used as a response element in the DescribeDBProxies action.

" - } - }, - "com.amazonaws.rds#DBProxyAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyEndpoint": { - "type": "structure", - "members": { - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the DB proxy endpoint. An identifier must begin with a letter and\n must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen\n or contain two consecutive hyphens.

" - } - }, - "DBProxyEndpointArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB proxy endpoint.

" - } - }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB proxy that is associated with this DB proxy endpoint.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#DBProxyEndpointStatus", - "traits": { - "smithy.api#documentation": "

The current status of this DB proxy endpoint. A status of available means the\n endpoint is ready to handle requests. Other values indicate that you must wait for\n the endpoint to be ready, or take some action to resolve an issue.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID of the DB proxy endpoint.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Provides a list of VPC security groups that the DB proxy endpoint belongs to.

" - } - }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The EC2 subnet IDs for the DB proxy endpoint.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the DB proxy endpoint was first created.

" - } - }, - "TargetRole": { - "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

" - } - }, - "IsDefault": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.

\n

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

" - } - }, - "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyEndpointAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyEndpointList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBProxyEndpoint" - } - }, - "com.amazonaws.rds#DBProxyEndpointName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" - } - }, - "com.amazonaws.rds#DBProxyEndpointNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyEndpointNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The DB proxy endpoint doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyEndpointQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB proxy already has the maximum number of endpoints.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyEndpointStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "INCOMPATIBLE_NETWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "incompatible-network" - } - }, - "INSUFFICIENT_RESOURCE_LIMITS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "insufficient-resource-limits" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "creating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - } - } - }, - "com.amazonaws.rds#DBProxyEndpointTargetRole": { - "type": "enum", - "members": { - "READ_WRITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ_WRITE" - } - }, - "READ_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ_ONLY" - } - } - } - }, - "com.amazonaws.rds#DBProxyList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBProxy" - } - }, - "com.amazonaws.rds#DBProxyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" - } - }, - "com.amazonaws.rds#DBProxyNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBProxyQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "INCOMPATIBLE_NETWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "incompatible-network" - } - }, - "INSUFFICIENT_RESOURCE_LIMITS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "insufficient-resource-limits" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "creating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "SUSPENDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "suspended" - } - }, - "SUSPENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "suspending" - } - }, - "REACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "reactivating" - } - } - } - }, - "com.amazonaws.rds#DBProxyTarget": { - "type": "structure", - "members": { - "TargetArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The writer endpoint for the RDS DB instance or Aurora DB cluster.

" - } - }, - "TrackedClusterId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

" - } - }, - "RdsResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier representing the target. It can be the instance identifier for an RDS DB instance,\n or the cluster identifier for an Aurora DB cluster.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

" - } - }, - "Type": { - "target": "com.amazonaws.rds#TargetType", - "traits": { - "smithy.api#documentation": "

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

" - } - }, - "Role": { - "target": "com.amazonaws.rds#TargetRole", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

" - } - }, - "TargetHealth": { - "target": "com.amazonaws.rds#TargetHealth", - "traits": { - "smithy.api#documentation": "

Information about the connection health of the RDS Proxy target.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

\n

This data type is used as a response element in the DescribeDBProxyTargets action.

" - } - }, - "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyTargetAlreadyRegisteredFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyTargetGroup": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the RDS proxy associated with this target group.

" - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" - } - }, - "TargetGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the target group.

" - } - }, - "IsDefault": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The current status of this target group. A status of available means the\n target group is correctly associated with a database. Other values indicate that you must wait for\n the target group to be ready, or take some action to resolve an issue.

" - } - }, - "ConnectionPoolConfig": { - "target": "com.amazonaws.rds#ConnectionPoolConfigurationInfo", - "traits": { - "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the target group was first created.

" - } - }, - "UpdatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the target group was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.

\n

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" - } - }, - "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyTargetGroupNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBProxyTargetNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyTargetNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBSecurityGroup": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of a specific DB security group.

" - } - }, - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the DB security group.

" - } - }, - "DBSecurityGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the description of the DB security group.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VpcId of the DB security group.

" - } - }, - "EC2SecurityGroups": { - "target": "com.amazonaws.rds#EC2SecurityGroupList", - "traits": { - "smithy.api#documentation": "

Contains a list of EC2SecurityGroup elements.

" - } - }, - "IPRanges": { - "target": "com.amazonaws.rds#IPRangeList", - "traits": { - "smithy.api#documentation": "

Contains a list of IPRange elements.

" - } - }, - "DBSecurityGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details for an Amazon RDS DB security group.

\n

This data type is used as a response element \n in the DescribeDBSecurityGroups action.

" - } - }, - "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSecurityGroupAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A DB security group with the name specified in\n DBSecurityGroupName already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSecurityGroupMembership": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the DB security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \n
" - } - }, - "com.amazonaws.rds#DBSecurityGroupMembershipList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSecurityGroupMembership", - "traits": { - "smithy.api#xmlName": "DBSecurityGroup" - } - } - }, - "com.amazonaws.rds#DBSecurityGroupMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroups", - "traits": { - "smithy.api#documentation": "

A list of DBSecurityGroup instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBSecurityGroupNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "DBSecurityGroupName" - } - } - }, - "com.amazonaws.rds#DBSecurityGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSecurityGroupNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing DB security group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBSecurityGroupNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSecurityGroupNotSupported", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A DB security group isn't allowed for this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "QuotaExceeded.DBSecurityGroup", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB security\n groups.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSecurityGroup", - "traits": { - "smithy.api#xmlName": "DBSecurityGroup" - } - } - }, - "com.amazonaws.rds#DBSnapshot": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the identifier for the DB snapshot.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

" - } - }, - "SnapshotCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the database engine.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of this DB snapshot.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the database engine was listening on at the time of the snapshot.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB snapshot.

" - } - }, - "InstanceCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from\n which the snapshot was taken, was created.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the master username for the DB snapshot.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the version of the database engine.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

" - } - }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the type of the DB snapshot.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the option group name for the DB snapshot.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" - } - }, - "SourceRegion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

" - } - }, - "SourceDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type associated with DB snapshot.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB snapshot is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "DBSnapshotArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB snapshot.

" - } - }, - "Timezone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance when the DB snapshot was created.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "OriginalSnapshotCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

" - } - }, - "SnapshotDatabaseTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

\n

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.

" - } - }, - "SnapshotTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the DB snapshot.

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. The Oracle SID is also the name of your CDB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB snapshot.

\n

This data type is used as a response element \n in the DescribeDBSnapshots action.

" - } - }, - "com.amazonaws.rds#DBSnapshotAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSnapshotAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSnapshotAttribute": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" - } - }, - "AttributeValues": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" - } - }, - "com.amazonaws.rds#DBSnapshotAttributeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSnapshotAttribute", - "traits": { - "smithy.api#xmlName": "DBSnapshotAttribute" - } - } - }, - "com.amazonaws.rds#DBSnapshotAttributesResult": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the manual DB snapshot that the attributes apply to.

" - } - }, - "DBSnapshotAttributes": { - "target": "com.amazonaws.rds#DBSnapshotAttributeList", - "traits": { - "smithy.api#documentation": "

The list of attributes and values for the manual DB snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" - } - }, - "com.amazonaws.rds#DBSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSnapshot", - "traits": { - "smithy.api#xmlName": "DBSnapshot" - } - } - }, - "com.amazonaws.rds#DBSnapshotMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBSnapshots": { - "target": "com.amazonaws.rds#DBSnapshotList", - "traits": { - "smithy.api#documentation": "

A list of DBSnapshot instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSnapshots action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBSnapshotNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSnapshotNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBSubnetGroup": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB subnet group.

" - } - }, - "DBSubnetGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the description of the DB subnet group.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VpcId of the DB subnet group.

" - } - }, - "SubnetGroupStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the status of the DB subnet group.

" - } - }, - "Subnets": { - "target": "com.amazonaws.rds#SubnetList", - "traits": { - "smithy.api#documentation": "

Contains a list of Subnet elements.

" - } - }, - "DBSubnetGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" - } - }, - "SupportedNetworkTypes": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The network type of the DB subnet group.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB subnet group.

\n

This data type is used as a response element \n in the DescribeDBSubnetGroups action.

" - } - }, - "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupDoesNotCoverEnoughAZs", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSubnetGroupMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBSubnetGroups": { - "target": "com.amazonaws.rds#DBSubnetGroups", - "traits": { - "smithy.api#documentation": "

A list of DBSubnetGroup instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DBSubnetGroupNotAllowedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupNotAllowedFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DBSubnetGroup shouldn't be specified while creating read replicas that lie\n in the same region as the source instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSubnetGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing DB subnet group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB subnet\n groups.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSubnetGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSubnetGroup", - "traits": { - "smithy.api#xmlName": "DBSubnetGroup" - } - } - }, - "com.amazonaws.rds#DBSubnetQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of subnets in a\n DB subnet groups.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBUpgradeDependencyFailureFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBUpgradeDependencyFailure", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB upgrade failed because a resource the DB depends on can't be\n modified.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DatabaseArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[A-Za-z][0-9A-Za-z-:._]*$" - } - }, - "com.amazonaws.rds#DeleteBlueGreenDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a blue/green deployment.

\n

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

" - } - }, - "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest": { - "type": "structure", - "members": { - "BlueGreenDeploymentIdentifier": { - "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier of the blue/green deployment to delete. This parameter isn't\n case-sensitive.

\n

Constraints:\n

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "DeleteTarget": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to delete the resources in the green environment. You can't specify\n this option if the blue/green deployment status is\n SWITCHOVER_COMPLETED.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse": { - "type": "structure", - "members": { - "BlueGreenDeployment": { - "target": "com.amazonaws.rds#BlueGreenDeployment" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteCustomDBEngineVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBEngineVersion" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

\n
    \n
  • \n

    The CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.

    \n
    • \n
  • \n

    The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.

    \n
    • \n
\n

Typically, deletion takes a few minutes.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.

\n \n

For more information, see Deleting a\n CEV in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#CustomEngineName", - "traits": { - "smithy.api#documentation": "

The database engine. The only supported engines are custom-oracle-ee and custom-oracle-ee-cdb.

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#CustomEngineVersion", - "traits": { - "smithy.api#documentation": "

The custom engine version (CEV) for your DB instance. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

\n

If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are\n terminated and read replicas are promoted to standalone instances.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To delete a DB cluster", - "documentation": "The following example deletes the DB cluster named mycluster and takes a final snapshot named mycluster-final-snapshot. The status of the DB cluster is available while the snapshot is being taken. ", - "input": { - "DBClusterIdentifier": "mycluster", - "SkipFinalSnapshot": false, - "FinalDBSnapshotIdentifier": "mycluster-final-snapshot" - }, - "output": { - "DBCluster": { - "AllocatedStorage": 20, - "AvailabilityZones": [ - "eu-central-1b", - "eu-central-1c", - "eu-central-1a" - ], - "BackupRetentionPeriod": 7, - "DBClusterIdentifier": "mycluster", - "DBClusterParameterGroup": "default.aurora-postgresql10", - "DBSubnetGroup": "default-vpc-aa11bb22", - "Status": "available" - } - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBClusterAutomatedBackup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon \n Resource Name (ARN) of the automated backups.

" - } - }, - "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage": { - "type": "structure", - "members": { - "DbClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult": { - "type": "structure", - "members": { - "DBClusterAutomatedBackup": { - "target": "com.amazonaws.rds#DBClusterAutomatedBackup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteDBClusterEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterEndpointMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterEndpoint" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To delete a custom DB cluster endpoint", - "documentation": "The following example deletes the specified custom DB cluster endpoint.", - "input": { - "DBClusterEndpointIdentifier": "mycustomendpoint" - }, - "output": { - "DBClusterEndpointIdentifier": "mycustomendpoint", - "DBClusterIdentifier": "mydbcluster", - "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", - "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", - "Status": "deleting", - "EndpointType": "CUSTOM", - "CustomEndpointType": "READER", - "StaticMembers": [ - "dbinstance1", - "dbinstance2", - "dbinstance3" - ], - "ExcludedMembers": [], - "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBClusterEndpointMessage": { - "type": "structure", - "members": { - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing DBClusterIdentifier.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "SkipFinalSnapshot": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

\n \n

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

\n " - } - }, - "FinalDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.

\n \n

Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.

\n \n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" - } - }, - "DeleteAutomatedBackups": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To delete a DB cluster parameter group", - "documentation": "The following example deletes the specified DB cluster parameter group.", - "input": { - "DBClusterParameterGroupName": "mydbclusterparametergroup" - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    You can't delete a default DB cluster parameter group.

    \n
    • \n
  • \n

    Can't be associated with any DB clusters.

    \n
    • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteDBClusterSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBClusterSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

\n \n

The DB cluster snapshot must be in the available state to be\n deleted.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To delete a DB cluster snapshot", - "documentation": "", - "input": { - "DBClusterSnapshotIdentifier": "mydbclustersnapshot" - }, - "output": { - "DBClusterSnapshot": { - "AvailabilityZones": [ - "us-east-1a", - "us-east-1b", - "us-east-1e" - ], - "DBClusterSnapshotIdentifier": "mydbclustersnapshot", - "DBClusterIdentifier": "mydbcluster", - "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", - "Engine": "aurora-mysql", - "AllocatedStorage": 0, - "Status": "available", - "Port": 0, - "VpcId": "vpc-6594f31c", - "ClusterCreateTime": "2019-04-15T14:18:42.785Z", - "MasterUsername": "myadmin", - "EngineVersion": "5.7.mysql_aurora.2.04.2", - "LicenseModel": "aurora-mysql", - "SnapshotType": "manual", - "PercentProgress": 100, - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", - "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", - "IAMDatabaseAuthenticationEnabled": false - } - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to delete.

\n

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBClusterSnapshotResult": { - "type": "structure", - "members": { - "DBClusterSnapshot": { - "target": "com.amazonaws.rds#DBClusterSnapshot" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

\n

If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n
    \n
  • \n

    The DB cluster is a read replica of another Amazon Aurora DB cluster.

    \n
    • \n
  • \n

    The DB instance is the only instance in the DB cluster.

    \n
    • \n
\n

To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

", - "smithy.api#examples": [ - { - "title": "To delete a DB instance", - "documentation": "The following example deletes the specified DB instance after creating a final DB snapshot named test-instance-final-snap.", - "input": { - "DBInstanceIdentifier": "test-instance", - "SkipFinalSnapshot": false, - "FinalDBSnapshotIdentifier": "test-instance-final-snap" - }, - "output": { - "DBInstance": { - "DBInstanceIdentifier": "test-instance", - "DBInstanceStatus": "deleting" - } - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

", - "smithy.api#examples": [ - { - "title": "To delete a replicated automated backup from a Region", - "documentation": "The following example deletes the automated backup with the specified Amazon Resource Name (ARN).", - "input": { - "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" - }, - "output": { - "DBInstanceAutomatedBackup": { - "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", - "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", - "Region": "us-east-1", - "DBInstanceIdentifier": "new-orcl-db", - "RestoreWindow": {}, - "AllocatedStorage": 20, - "Status": "deleting", - "Port": 1521, - "AvailabilityZone": "us-east-1b", - "VpcId": "vpc-########", - "InstanceCreateTime": "2020-12-04T15:28:31Z", - "MasterUsername": "admin", - "Engine": "oracle-se2", - "EngineVersion": "12.1.0.2.v21", - "LicenseModel": "bring-your-own-license", - "OptionGroupName": "default:oracle-se2-12-1", - "Encrypted": false, - "StorageType": "gp2", - "IAMDatabaseAuthenticationEnabled": false, - "BackupRetentionPeriod": 7, - "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" - } - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage": { - "type": "structure", - "members": { - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "DBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult": { - "type": "structure", - "members": { - "DBInstanceAutomatedBackup": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB instance.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "SkipFinalSnapshot": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n \n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" - } - }, - "FinalDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.

\n \n

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

\n \n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
  • \n

    Can't be specified when deleting a read replica.

    \n
    • \n
" - } - }, - "DeleteAutomatedBackups": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBParameterGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

", - "smithy.api#examples": [ - { - "title": "To delete a DB parameter group", - "documentation": "The following example deletes a DB parameter group.", - "input": { - "DBParameterGroupName": "mydbparametergroup" - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBParameterGroupMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be the name of an existing DB parameter group

    \n
    • \n
  • \n

    You can't delete a default DB parameter group

    \n
    • \n
  • \n

    Can't be associated with any DB instances

    \n
    • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBProxy": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBProxyRequest" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBProxyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing DB proxy.

" - } - }, - "com.amazonaws.rds#DeleteDBProxyEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBProxyEndpointRequest" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBProxyEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the\n endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write\n or read-only operations, or using a different VPC than the DB proxy's default VPC.

" - } - }, - "com.amazonaws.rds#DeleteDBProxyEndpointRequest": { - "type": "structure", - "members": { - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy endpoint to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBProxyEndpointResponse": { - "type": "structure", - "members": { - "DBProxyEndpoint": { - "target": "com.amazonaws.rds#DBProxyEndpoint", - "traits": { - "smithy.api#documentation": "

The data structure representing the details of the DB proxy endpoint that you delete.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteDBProxyRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBProxyResponse": { - "type": "structure", - "members": { - "DBProxy": { - "target": "com.amazonaws.rds#DBProxy", - "traits": { - "smithy.api#documentation": "

The data structure representing the details of the DB proxy that you delete.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteDBSecurityGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBSecurityGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DB security group.

\n

The specified DB security group must not be associated with any DB instances.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", - "smithy.api#examples": [ - { - "title": "To delete a DB security group", - "documentation": "The following example deletes a DB security group.", - "input": { - "DBSecurityGroupName": "mysecgroup" - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group to delete.

\n \n

You can't delete the default DB security group.

\n \n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

\n \n

The DB snapshot must be in the available state to be deleted.

\n ", - "smithy.api#examples": [ - { - "title": "To delete a DB snapshot", - "documentation": "The following example deletes the specified DB snapshot.", - "input": { - "DBSnapshotIdentifier": "mydbsnapshot" - }, - "output": { - "DBSnapshot": { - "DBSnapshotIdentifier": "mydbsnapshot", - "DBInstanceIdentifier": "database-mysql", - "SnapshotCreateTime": "2019-06-18T22:08:40.702Z", - "Engine": "mysql", - "AllocatedStorage": 100, - "Status": "deleted", - "Port": 3306, - "AvailabilityZone": "us-east-1b", - "VpcId": "vpc-6594f31c", - "InstanceCreateTime": "2019-04-30T15:45:53.663Z", - "MasterUsername": "admin", - "EngineVersion": "5.6.40", - "LicenseModel": "general-public-license", - "SnapshotType": "manual", - "Iops": 1000, - "OptionGroupName": "default:mysql-5-6", - "PercentProgress": 100, - "StorageType": "io1", - "Encrypted": true, - "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", - "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", - "IAMDatabaseAuthenticationEnabled": false, - "ProcessorFeatures": [], - "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" - } - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBSnapshotMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB snapshot identifier.

\n

Constraints: Must be the name of an existing DB snapshot in the available state.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteDBSnapshotResult": { - "type": "structure", - "members": { - "DBSnapshot": { - "target": "com.amazonaws.rds#DBSnapshot" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteDBSubnetGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBSubnetGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DB subnet group.

\n \n

The specified database subnet group must not be associated with any DB instances.

\n ", - "smithy.api#examples": [ - { - "title": "To delete a DB subnet group", - "documentation": "The following example deletes the DB subnet group called mysubnetgroup.", - "input": { - "DBSubnetGroupName": "mysubnetgroup" - } - } - ] - } - }, - "com.amazonaws.rds#DeleteDBSubnetGroupMessage": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database subnet group to delete.

\n \n

You can't delete the default subnet group.

\n \n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteEventSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteEventSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteEventSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InvalidEventSubscriptionStateFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an RDS event notification subscription.

", - "smithy.api#examples": [ - { - "title": "To delete an event subscription", - "documentation": "The following example deletes the specified event subscription.", - "input": { - "SubscriptionName": "my-instance-events" - }, - "output": { - "EventSubscription": { - "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", - "CustomerAwsId": "123456789012", - "Enabled": false, - "SourceIdsList": [ - "test-instance" - ], - "SourceType": "db-instance", - "EventCategoriesList": [ - "backup", - "recovery" - ], - "SubscriptionCreationTime": "2018-07-31 23:22:01.893", - "CustSubscriptionId": "my-instance-events", - "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", - "Status": "deleting" - } - } - } - ] - } - }, - "com.amazonaws.rds#DeleteEventSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription you want to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteEventSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To delete a global DB cluster", - "documentation": "The following example deletes an Aurora MySQL-compatible global DB cluster.", - "input": { - "GlobalClusterIdentifier": "myglobalcluster" - }, - "output": { - "GlobalCluster": { - "GlobalClusterIdentifier": "myglobalcluster", - "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", - "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", - "Status": "available", - "Engine": "aurora-mysql", - "EngineVersion": "5.7.mysql_aurora.2.07.2", - "StorageEncrypted": false, - "DeletionProtection": false, - "GlobalClusterMembers": [] - } - } - } - ] - } - }, - "com.amazonaws.rds#DeleteGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The cluster identifier of the global database cluster being deleted.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeleteGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DeleteOptionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteOptionGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing option group.

", - "smithy.api#examples": [ - { - "title": "To delete an option group", - "documentation": "The following example deletes the specified option group.", - "input": { - "OptionGroupName": "myoptiongroup" - } - } - ] - } - }, - "com.amazonaws.rds#DeleteOptionGroupMessage": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to be deleted.

\n \n

You can't delete default option groups.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeregisterDBProxyTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeregisterDBProxyTargetsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DeregisterDBProxyTargetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

" - } - }, - "com.amazonaws.rds#DeregisterDBProxyTargetsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", - "smithy.api#required": {} - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" - } - }, - "DBInstanceIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more DB instance identifiers.

" - } - }, - "DBClusterIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more DB cluster identifiers.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DeregisterDBProxyTargetsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeAccountAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeAccountAttributesMessage" - }, - "output": { - "target": "com.amazonaws.rds#AccountAttributesMessage" - }, - "traits": { - "smithy.api#documentation": "

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

\n

This command doesn't take any parameters.

", - "smithy.api#examples": [ - { - "title": "To describe account attributes", - "documentation": "The following example retrieves the attributes for the current AWS account.", - "output": { - "AccountQuotas": [ - { - "Max": 40, - "Used": 4, - "AccountQuotaName": "DBInstances" - }, - { - "Max": 40, - "Used": 0, - "AccountQuotaName": "ReservedDBInstances" - }, - { - "Max": 100000, - "Used": 40, - "AccountQuotaName": "AllocatedStorage" - }, - { - "Max": 25, - "Used": 0, - "AccountQuotaName": "DBSecurityGroups" - }, - { - "Max": 20, - "Used": 0, - "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" - }, - { - "Max": 50, - "Used": 1, - "AccountQuotaName": "DBParameterGroups" - }, - { - "Max": 100, - "Used": 3, - "AccountQuotaName": "ManualSnapshots" - }, - { - "Max": 20, - "Used": 0, - "AccountQuotaName": "EventSubscriptions" - }, - { - "Max": 50, - "Used": 1, - "AccountQuotaName": "DBSubnetGroups" - }, - { - "Max": 20, - "Used": 1, - "AccountQuotaName": "OptionGroups" - }, - { - "Max": 20, - "Used": 6, - "AccountQuotaName": "SubnetsPerDBSubnetGroup" - }, - { - "Max": 5, - "Used": 0, - "AccountQuotaName": "ReadReplicasPerMaster" - }, - { - "Max": 40, - "Used": 1, - "AccountQuotaName": "DBClusters" - }, - { - "Max": 50, - "Used": 0, - "AccountQuotaName": "DBClusterParameterGroups" - }, - { - "Max": 5, - "Used": 0, - "AccountQuotaName": "DBClusterRoles" - } - ] - } - } - ] - } - }, - "com.amazonaws.rds#DescribeAccountAttributesMessage": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeBlueGreenDeployments": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes one or more blue/green deployments.

\n

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

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "BlueGreenDeployments", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest": { - "type": "structure", - "members": { - "BlueGreenDeploymentIdentifier": { - "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", - "traits": { - "smithy.api#documentation": "

The blue/green deployment identifier. If you specify this parameter, the response only\n includes information about the specific blue/green deployment. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more blue/green deployments to describe.

\n

Valid Values:

\n
    \n
  • \n

    \n blue-green-deployment-identifier - Accepts system-generated\n identifiers for blue/green deployments. The results list only includes\n information about the blue/green deployments with the specified\n identifiers.

    \n
    • \n
  • \n

    \n blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. \n The results list only includes information about the blue/green deployments with the \n specified names.

    \n
    • \n
  • \n

    \n source - Accepts source databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified source databases.

    \n
    • \n
  • \n

    \n target - Accepts target databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified target databases.

    \n
    • \n
" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeBlueGreenDeployments request. If you specify this parameter,\n the response only includes records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints:

\n
    \n
  • \n

    Must be a minimum of 20.

    \n
    • \n
  • \n

    Can't exceed 100.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse": { - "type": "structure", - "members": { - "BlueGreenDeployments": { - "target": "com.amazonaws.rds#BlueGreenDeploymentList", - "traits": { - "smithy.api#documentation": "

A list of blue/green deployments in the current account and Amazon Web Services Region.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later\n DescribeBlueGreenDeployments request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeCertificates": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeCertificatesMessage" - }, - "output": { - "target": "com.amazonaws.rds#CertificateMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CertificateNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Certificates", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeCertificatesMessage": { - "type": "structure", - "members": { - "CertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing CertificateIdentifier.

    \n
    • \n
" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBClusterAutomatedBackups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterAutomatedBackupMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Displays backups for both current and deleted DB clusters. For example, use this operation to find details \n about automated backups for previously deleted clusters. Current clusters are returned for both the \n DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.

\n

All parameters are optional.

" - } - }, - "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage": { - "type": "structure", - "members": { - "DbClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must\n match the identifier of an existing DB cluster. It returns information from the\n specific DB cluster's automated backup. This parameter isn't case-sensitive.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n
    \n
  • \n

    \n status\n

    \n
      \n
    • \n

      \n retained - Automated backups for deleted clusters and after backup replication is stopped.

      \n
      • \n
    \n
    • \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster automated backups identified by these ARNs.

    \n
    • \n
  • \n

    \n db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster resources identified by these ARNs.

    \n
    • \n
\n

Returns all resources by default. The status for each resource is specified in the response.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords \n value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBClusterBacktracks": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterBacktracksMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterBacktrackMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterBacktrackNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about backtracks for a DB cluster.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora MySQL DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To describe backtracks for a DB cluster", - "documentation": "The following example retrieves details about the specified DB cluster.", - "input": { - "DBClusterIdentifier": "mydbcluster" - }, - "output": { - "DBClusterBacktracks": [ - { - "DBClusterIdentifier": "mydbcluster", - "BacktrackIdentifier": "2f5f5294-0dd2-44c9-9f50-EXAMPLE", - "BacktrackTo": "2021-02-12T04:59:22Z", - "BacktrackedFrom": "2021-02-12T14:37:31.640Z", - "BacktrackRequestCreationTime": "2021-02-12T14:36:18.819Z", - "Status": "COMPLETED" - }, - { - "DBClusterIdentifier": "mydbcluster", - "BacktrackIdentifier": "3c7a6421-af2a-4ea3-ae95-EXAMPLE", - "BacktrackTo": "2021-02-11T22:53:46Z", - "BacktrackedFrom": "2021-02-12T00:09:27.006Z", - "BacktrackRequestCreationTime": "2021-02-12T00:07:53.487Z", - "Status": "COMPLETED" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusterBacktracks", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterBacktracksMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "BacktrackIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If specified, this value is the backtrack identifier of the backtrack to be\n described.

\n

Constraints:

\n \n

Example: 123e4567-e89b-12d3-a456-426655440000\n

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

\n
    \n
  • \n

    \n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.

    \n
    • \n
  • \n

    \n db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    \n
      \n
    • \n

      \n applying\n

      \n
      • \n
    • \n

      \n completed\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n pending\n

      \n
      • \n
    \n

    The results list includes information about only the backtracks identified\n by these values.

    \n
    • \n
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBClusterEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterEndpointsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterEndpointMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about endpoints for an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To describe DB cluster endpoints", - "documentation": "The following example retrieves details for your DB cluster endpoints. The most common kinds of Aurora clusters have two endpoints. One endpoint has type WRITER. You can use this endpoint for all SQL statements. The other endpoint has type READER. You can use this endpoint only for SELECT and other read-only SQL statements.", - "output": { - "DBClusterEndpoints": [ - { - "DBClusterIdentifier": "my-database-1", - "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com", - "Status": "creating", - "EndpointType": "WRITER" - }, - { - "DBClusterIdentifier": "my-database-1", - "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", - "Status": "creating", - "EndpointType": "READER" - }, - { - "DBClusterIdentifier": "mydbcluster", - "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com", - "Status": "available", - "EndpointType": "WRITER" - }, - { - "DBClusterIdentifier": "mydbcluster", - "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", - "Status": "available", - "EndpointType": "READER" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusterEndpoints", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterEndpointsMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" - } - }, - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBClusterParameterGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterParameterGroupsMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To describe DB cluster parameter groups", - "documentation": "The following example retrieves details for your DB cluster parameter groups.", - "output": { - "DBClusterParameterGroups": [ - { - "DBClusterParameterGroupName": "default.aurora-mysql5.7", - "DBParameterGroupFamily": "aurora-mysql5.7", - "Description": "Default cluster parameter group for aurora-mysql5.7", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" - }, - { - "DBClusterParameterGroupName": "default.aurora-postgresql9.6", - "DBParameterGroupFamily": "aurora-postgresql9.6", - "Description": "Default cluster parameter group for aurora-postgresql9.6", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" - }, - { - "DBClusterParameterGroupName": "default.aurora5.6", - "DBParameterGroupFamily": "aurora5.6", - "Description": "Default cluster parameter group for aurora5.6", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" - }, - { - "DBClusterParameterGroupName": "mydbclusterpg", - "DBParameterGroupFamily": "aurora-mysql5.7", - "Description": "My DB cluster parameter group", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" - }, - { - "DBClusterParameterGroupName": "mydbclusterpgcopy", - "DBParameterGroupFamily": "aurora-mysql5.7", - "Description": "Copy of mydbclusterpg parameter group", - "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusterParameterGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBClusterParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterParametersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterParameterGroupDetails" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To describe the parameters in a DB cluster parameter group", - "documentation": "The following example retrieves details about the parameters in a DB cluster parameter group.", - "input": { - "DBClusterParameterGroupName": "mydbclusterpg" - }, - "output": { - "Parameters": [ - { - "ParameterName": "allow-suspicious-udfs", - "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": false, - "ApplyMethod": "pending-reboot", - "SupportedEngineModes": [ - "provisioned" - ] - }, - { - "ParameterName": "aurora_lab_mode", - "ParameterValue": "0", - "Description": "Enables new features in the Aurora engine.", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": true, - "ApplyMethod": "pending-reboot", - "SupportedEngineModes": [ - "provisioned" - ] - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Parameters", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterParametersMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

", - "smithy.api#examples": [ - { - "title": "To describe the attribute names and values for a DB cluster snapshot", - "documentation": "The following example retrieves details of the attribute names and values for the specified DB cluster snapshot.", - "input": { - "DBClusterSnapshotIdentifier": "myclustersnapshot" - }, - "output": { - "DBClusterSnapshotAttributesResult": { - "DBClusterSnapshotIdentifier": "myclustersnapshot", - "DBClusterSnapshotAttributes": [ - { - "AttributeName": "restore", - "AttributeValues": [ - "123456789012" - ] - } - ] - } - } - } - ] - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB cluster snapshot to describe the attributes for.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult": { - "type": "structure", - "members": { - "DBClusterSnapshotAttributesResult": { - "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterSnapshotMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB cluster snapshots. This API action supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To describe a DB cluster snapshot for a DB cluster", - "documentation": "The following example retrieves the details for the DB cluster snapshots for the specified DB cluster.", - "input": { - "DBClusterIdentifier": "mydbcluster" - }, - "output": { - "DBClusterSnapshots": [ - { - "AvailabilityZones": [ - "us-east-1a", - "us-east-1b", - "us-east-1e" - ], - "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", - "DBClusterIdentifier": "mydbcluster", - "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", - "Engine": "aurora-mysql", - "AllocatedStorage": 0, - "Status": "available", - "Port": 0, - "VpcId": "vpc-6594f31c", - "ClusterCreateTime": "2019-04-15T14:18:42.785Z", - "MasterUsername": "myadmin", - "EngineVersion": "5.7.mysql_aurora.2.04.2", - "LicenseModel": "aurora-mysql", - "SnapshotType": "manual", - "PercentProgress": 100, - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", - "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", - "IAMDatabaseAuthenticationEnabled": false - }, - { - "AvailabilityZones": [ - "us-east-1a", - "us-east-1b", - "us-east-1e" - ], - "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", - "DBClusterIdentifier": "mydbcluster", - "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", - "Engine": "aurora-mysql", - "AllocatedStorage": 0, - "Status": "available", - "Port": 0, - "VpcId": "vpc-6594f31c", - "ClusterCreateTime": "2019-04-15T14:18:42.785Z", - "MasterUsername": "myadmin", - "EngineVersion": "5.7.mysql_aurora.2.04.2", - "LicenseModel": "aurora-mysql", - "SnapshotType": "automated", - "PercentProgress": 100, - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", - "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", - "IAMDatabaseAuthenticationEnabled": false - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusterSnapshots", - "pageSize": "MaxRecords" - }, - "smithy.waiters#waitable": { - "DBClusterSnapshotAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "incompatible-restore", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "incompatible-parameters", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "DBClusterSnapshotDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(DBClusterSnapshots) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "DBClusterSnapshotNotFoundFault" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "resetting-master-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBCluster.

    \n
    • \n
" - } - }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBClusterSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \n
" - } - }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n
    \n
  • \n

    \n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB cluster snapshots that have been marked as public.

    \n
    • \n
\n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB cluster snapshots to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB cluster snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

    \n
    • \n
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "IncludeShared": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" - } - }, - "IncludePublic": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" - } - }, - "DbClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A specific DB cluster resource ID to describe.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClustersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

", - "smithy.api#examples": [ - { - "title": "To describe a DB cluster", - "documentation": "The following example retrieves the details of the specified DB cluster.", - "input": { - "DBClusterIdentifier": "mydbcluster" - }, - "output": { - "DBClusters": [ - { - "AllocatedStorage": 1, - "AvailabilityZones": [ - "us-east-1a", - "us-east-1b", - "us-east-1e" - ], - "BackupRetentionPeriod": 1, - "DatabaseName": "mydbcluster", - "DBClusterIdentifier": "mydbcluster", - "DBClusterParameterGroup": "default.aurora-mysql5.7", - "DBSubnetGroup": "default", - "Status": "available", - "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", - "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", - "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", - "MultiAZ": true, - "Engine": "aurora-mysql", - "EngineVersion": "5.7.mysql_aurora.2.04.2", - "LatestRestorableTime": "2019-06-20T22:38:14.908Z", - "Port": 3306, - "MasterUsername": "myadmin", - "PreferredBackupWindow": "09:09-09:39", - "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", - "ReadReplicaIdentifiers": [], - "DBClusterMembers": [ - { - "DBInstanceIdentifier": "dbinstance3", - "IsClusterWriter": false, - "DBClusterParameterGroupStatus": "in-sync", - "PromotionTier": 1 - }, - { - "DBInstanceIdentifier": "dbinstance1", - "IsClusterWriter": false, - "DBClusterParameterGroupStatus": "in-sync", - "PromotionTier": 1 - }, - { - "DBInstanceIdentifier": "dbinstance2", - "IsClusterWriter": false, - "DBClusterParameterGroupStatus": "in-sync", - "PromotionTier": 1 - }, - { - "DBInstanceIdentifier": "mydbcluster", - "IsClusterWriter": false, - "DBClusterParameterGroupStatus": "in-sync", - "PromotionTier": 1 - }, - { - "DBInstanceIdentifier": "mydbcluster-us-east-1b", - "IsClusterWriter": false, - "DBClusterParameterGroupStatus": "in-sync", - "PromotionTier": 1 - }, - { - "DBInstanceIdentifier": "mydbcluster", - "IsClusterWriter": true, - "DBClusterParameterGroupStatus": "in-sync", - "PromotionTier": 1 - } - ], - "VpcSecurityGroups": [ - { - "VpcSecurityGroupId": "sg-0b9130572daf3dc16", - "Status": "active" - } - ], - "HostedZoneId": "Z2R2ITUGPM61AM", - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", - "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", - "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", - "AssociatedRoles": [], - "IAMDatabaseAuthenticationEnabled": false, - "ClusterCreateTime": "2019-04-15T14:18:42.785Z", - "EngineMode": "provisioned", - "DeletionProtection": false, - "HttpEndpointEnabled": false - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusters", - "pageSize": "MaxRecords" - }, - "smithy.waiters#waitable": { - "DBClusterAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "incompatible-restore", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "incompatible-parameters", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "DBClusterDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(DBClusters) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "DBClusterNotFoundFault" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "resetting-master-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.rds#DescribeDBClustersMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DB cluster identifier.

    \n
    • \n
" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported Filters:

\n
    \n
  • \n

    \n clone-group-id - Accepts clone group identifiers. \n The results list only includes information about\n the DB clusters associated with these clone groups.

    \n
    • \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-cluster-resource-id - Accepts DB cluster resource identifiers.\n The results list will only include information about the DB clusters identified\n by these DB cluster resource identifiers.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.

    \n
    • \n
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "IncludeShared": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBEngineVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBEngineVersionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBEngineVersionMessage" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of the available DB engines.

", - "smithy.api#examples": [ - { - "title": "To describe the DB engine versions for the MySQL DB engine", - "documentation": "The following example displays details about each of the DB engine versions for the specified DB engine.", - "input": { - "Engine": "mysql" - }, - "output": { - "DBEngineVersions": [ - { - "Engine": "mysql", - "EngineVersion": "5.7.33", - "DBParameterGroupFamily": "mysql5.7", - "DBEngineDescription": "MySQL Community Edition", - "DBEngineVersionDescription": "MySQL 5.7.33", - "ValidUpgradeTarget": [ - { - "Engine": "mysql", - "EngineVersion": "5.7.34", - "Description": "MySQL 5.7.34", - "AutoUpgrade": false, - "IsMajorVersionUpgrade": false - }, - { - "Engine": "mysql", - "EngineVersion": "5.7.36", - "Description": "MySQL 5.7.36", - "AutoUpgrade": false, - "IsMajorVersionUpgrade": false - } - ] - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBEngineVersions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBEngineVersionsMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBParameterGroupFamily.

    \n
    • \n
" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB engine versions to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-parameter-group-family - Accepts parameter groups family names. \n The results list only includes information about\n the DB engine versions for these parameter group families.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB engine versions for these engines.

    \n
    • \n
  • \n

    \n engine-mode - Accepts DB engine modes. \n The results list only includes information about\n the DB engine versions for these engine modes. Valid \n DB engine modes are the following:

    \n
      \n
    • \n

      \n global\n

      \n
      • \n
    • \n

      \n multimaster\n

      \n
      • \n
    • \n

      \n parallelquery\n

      \n
      • \n
    • \n

      \n provisioned\n

      \n
      • \n
    • \n

      \n serverless\n

      \n
      • \n
    \n
    • \n
  • \n

    \n engine-version - Accepts engine versions. \n The results list only includes information about\n the DB engine versions for these engine versions.

    \n
    • \n
  • \n

    \n status - Accepts engine version statuses. \n The results list only includes information about\n the DB engine versions for these statuses. Valid statuses \n are the following:

    \n
      \n
    • \n

      \n available\n

      \n
      • \n
    • \n

      \n deprecated\n

      \n
      • \n
    \n
    • \n
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DefaultOnly": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

" - } - }, - "ListSupportedCharacterSets": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.

" - } - }, - "ListSupportedTimezones": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.

\n

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.

" - } - }, - "IncludeAll": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.

\n

All parameters are optional.

", - "smithy.api#examples": [ - { - "title": "To describe the automated backups for a DB instance", - "documentation": "The following example displays details about the automated backups for the specified DB instance. The details include replicated automated backups in other AWS Regions.", - "input": { - "DBInstanceIdentifier": "new-orcl-db" - }, - "output": { - "DBInstanceAutomatedBackups": [ - { - "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", - "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", - "Region": "us-east-1", - "DBInstanceIdentifier": "new-orcl-db", - "RestoreWindow": { - "EarliestTime": "2020-12-07T21:05:20.939Z", - "LatestTime": "2020-12-07T21:05:20.939Z" - }, - "AllocatedStorage": 20, - "Status": "replicating", - "Port": 1521, - "InstanceCreateTime": "2020-12-04T15:28:31Z", - "MasterUsername": "admin", - "Engine": "oracle-se2", - "EngineVersion": "12.1.0.2.v21", - "LicenseModel": "bring-your-own-license", - "OptionGroupName": "default:oracle-se2-12-1", - "Encrypted": false, - "StorageType": "gp2", - "IAMDatabaseAuthenticationEnabled": false, - "BackupRetentionPeriod": 14, - "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBInstanceAutomatedBackups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage": { - "type": "structure", - "members": { - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The resource ID of the DB instance that is the source of \n the automated backup. This parameter isn't case-sensitive.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance's automated backup. This parameter isn't case-sensitive.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n
    \n
  • \n

    \n status\n

    \n
      \n
    • \n

      \n active - Automated backups for current instances.

      \n
      • \n
    • \n

      \n creating - Automated backups that are waiting for the first automated snapshot to be available.

      \n
      • \n
    • \n

      \n retained - Automated backups for deleted instances and after backup replication is stopped.

      \n
      • \n
    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance automated backups identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance resources identified by these ARNs.

    \n
    • \n
\n

Returns all resources by default. The status for each resource is specified in the response.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n you can retrieve the remaining results.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response \n includes only records beyond the marker, up to MaxRecords.

" - } - }, - "DBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameter input for DescribeDBInstanceAutomatedBackups.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBInstancesMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBInstanceMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

\n ", - "smithy.api#examples": [ - { - "title": "To describe a DB instance", - "documentation": "The following example retrieves details about the specified DB instance.", - "input": { - "DBInstanceIdentifier": "mydbinstancecf" - }, - "output": { - "DBInstances": [ - { - "DBInstanceIdentifier": "mydbinstancecf", - "DBInstanceClass": "db.t3.small", - "Engine": "mysql", - "DBInstanceStatus": "available", - "MasterUsername": "admin", - "Endpoint": { - "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com", - "Port": 3306, - "HostedZoneId": "Z2R2ITUGPM61AM" - } - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBInstances", - "pageSize": "MaxRecords" - }, - "smithy.api#suppress": [ - "WaitableTraitInvalidErrorType" - ], - "smithy.waiters#waitable": { - "DBInstanceAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "incompatible-restore", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "incompatible-parameters", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "DBInstanceDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(DBInstances) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "DBInstanceNotFound" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "resetting-master-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.rds#DescribeDBInstancesMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DB instance.

    \n
    • \n
" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported Filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB instance resource identifiers. The results list \n only includes information about the DB instances identified by these DB instance resource identifiers.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.

    \n
    • \n
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBLogFiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBLogFilesMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBLogFilesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DB log files for the DB instance.

\n

This command doesn't apply to RDS Custom.

", - "smithy.api#examples": [ - { - "title": "To describe the log files for a DB instance", - "documentation": "The following example retrieves details about the log files for the specified DB instance.", - "input": { - "DBInstanceIdentifier": "test-instance" - }, - "output": { - "DescribeDBLogFiles": [ - { - "Size": 0, - "LastWritten": 1533060000000, - "LogFileName": "error/mysql-error-running.log" - }, - { - "Size": 2683, - "LastWritten": 1532994300000, - "LogFileName": "error/mysql-error-running.log.0" - }, - { - "Size": 107, - "LastWritten": 1533057300000, - "LogFileName": "error/mysql-error-running.log.18" - }, - { - "Size": 13105, - "LastWritten": 1532991000000, - "LogFileName": "error/mysql-error-running.log.23" - }, - { - "Size": 0, - "LastWritten": 1533061200000, - "LogFileName": "error/mysql-error.log" - }, - { - "Size": 3519, - "LastWritten": 1532989252000, - "LogFileName": "mysqlUpgrade" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DescribeDBLogFiles", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBLogFilesDetails": { - "type": "structure", - "members": { - "LogFileName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the log file for the specified DB instance.

" - } - }, - "LastWritten": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A POSIX timestamp when the last log entry was written.

" - } - }, - "Size": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size, in bytes, of the log file for the specified DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element to DescribeDBLogFiles.

" - } - }, - "com.amazonaws.rds#DescribeDBLogFilesList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DescribeDBLogFilesDetails", - "traits": { - "smithy.api#xmlName": "DescribeDBLogFilesDetails" - } - } - }, - "com.amazonaws.rds#DescribeDBLogFilesMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "FilenameContains": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Filters the available log files for log file names that contain the specified string.

" - } - }, - "FileLastWritten": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

" - } - }, - "FileSize": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Filters the available log files for files larger than the specified size.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBLogFilesResponse": { - "type": "structure", - "members": { - "DescribeDBLogFiles": { - "target": "com.amazonaws.rds#DescribeDBLogFilesList", - "traits": { - "smithy.api#documentation": "

The DB log files returned.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBLogFiles request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The response from a call to DescribeDBLogFiles.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeDBParameterGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBParameterGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBParameterGroupsMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.

", - "smithy.api#examples": [ - { - "title": "To describe your DB parameter groups", - "documentation": "The following example retrieves details about your DB parameter groups.", - "output": { - "DBParameterGroups": [ - { - "DBParameterGroupName": "default.aurora-mysql5.7", - "DBParameterGroupFamily": "aurora-mysql5.7", - "Description": "Default parameter group for aurora-mysql5.7", - "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7" - }, - { - "DBParameterGroupName": "default.aurora-postgresql9.6", - "DBParameterGroupFamily": "aurora-postgresql9.6", - "Description": "Default parameter group for aurora-postgresql9.6", - "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6" - }, - { - "DBParameterGroupName": "default.aurora5.6", - "DBParameterGroupFamily": "aurora5.6", - "Description": "Default parameter group for aurora5.6", - "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6" - }, - { - "DBParameterGroupName": "default.mariadb10.1", - "DBParameterGroupFamily": "mariadb10.1", - "Description": "Default parameter group for mariadb10.1", - "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBParameterGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBParameterGroupsMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBParametersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBParameterGroupDetails" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB parameter group.

", - "smithy.api#examples": [ - { - "title": "To describe the parameters in a DB parameter group", - "documentation": "The following example retrieves the details of the specified DB parameter group.", - "input": { - "DBParameterGroupName": "mydbpg" - }, - "output": { - "Parameters": [ - { - "ParameterName": "allow-suspicious-udfs", - "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": false, - "ApplyMethod": "pending-reboot" - }, - { - "ParameterName": "auto_generate_certs", - "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": false, - "ApplyMethod": "pending-reboot" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Parameters", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBParametersMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The parameter types to return.

\n

Default: All parameter types returned

\n

Valid Values: user | system | engine-default\n

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBProxies": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBProxiesRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBProxiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB proxies.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBProxies", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBProxiesRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your Amazon Web Services account ID.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBProxiesResponse": { - "type": "structure", - "members": { - "DBProxies": { - "target": "com.amazonaws.rds#DBProxyList", - "traits": { - "smithy.api#documentation": "

A return value representing an arbitrary number of DBProxy data structures.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeDBProxyEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBProxyEndpointsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBProxyEndpointsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB proxy endpoints.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBProxyEndpoints", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBProxyEndpointsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#DBProxyName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy whose endpoints you want to describe. If you omit\n this parameter, the output includes information about all DB proxy endpoints\n associated with all your DB proxies.

" - } - }, - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The name of a DB proxy endpoint to describe. If you omit this parameter,\n the output includes information about all DB proxy endpoints associated with\n the specified proxy.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBProxyEndpointsResponse": { - "type": "structure", - "members": { - "DBProxyEndpoints": { - "target": "com.amazonaws.rds#DBProxyEndpointList", - "traits": { - "smithy.api#documentation": "

The list of ProxyEndpoint objects returned by the API operation.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "TargetGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxy associated with the target group.

", - "smithy.api#required": {} - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse": { - "type": "structure", - "members": { - "TargetGroups": { - "target": "com.amazonaws.rds#TargetGroupList", - "traits": { - "smithy.api#documentation": "

An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeDBProxyTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBProxyTargetsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBProxyTargetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DBProxyTarget objects. This API supports pagination.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Targets", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTarget to describe.

", - "smithy.api#required": {} - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetsResponse": { - "type": "structure", - "members": { - "Targets": { - "target": "com.amazonaws.rds#TargetList", - "traits": { - "smithy.api#documentation": "

An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeDBSecurityGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBSecurityGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBSecurityGroupMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", - "smithy.api#examples": [ - { - "title": "To list DB security group settings", - "documentation": "This example lists settings for the specified security group.", - "input": { - "DBSecurityGroupName": "mydbsecuritygroup" - }, - "output": {} - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBSecurityGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBSecurityGroupsMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group to return details for.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBSnapshotAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

", - "smithy.api#examples": [ - { - "title": "To describe the attribute names and values for a DB snapshot", - "documentation": "The following example describes the attribute names and values for a DB snapshot.", - "input": { - "DBSnapshotIdentifier": "mydbsnapshot" - }, - "output": { - "DBSnapshotAttributesResult": { - "DBSnapshotIdentifier": "mydbsnapshot", - "DBSnapshotAttributes": [ - { - "AttributeName": "restore", - "AttributeValues": [ - "123456789012", - "210987654321" - ] - } - ] - } - } - } - ] - } - }, - "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot to describe the attributes for.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBSnapshotAttributesResult": { - "type": "structure", - "members": { - "DBSnapshotAttributesResult": { - "target": "com.amazonaws.rds#DBSnapshotAttributesResult" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeDBSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBSnapshotsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBSnapshotMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB snapshots. This API action supports pagination.

", - "smithy.api#examples": [ - { - "title": "To describe a DB snapshot for a DB instance", - "documentation": "The following example retrieves the details of a DB snapshot for a DB instance.", - "input": { - "DBSnapshotIdentifier": "mydbsnapshot" - }, - "output": { - "DBSnapshots": [ - { - "DBSnapshotIdentifier": "mydbsnapshot", - "DBInstanceIdentifier": "mysqldb", - "SnapshotCreateTime": "2018-02-08T22:28:08.598Z", - "Engine": "mysql", - "AllocatedStorage": 20, - "Status": "available", - "Port": 3306, - "AvailabilityZone": "us-east-1f", - "VpcId": "vpc-6594f31c", - "InstanceCreateTime": "2018-02-08T22:24:55.973Z", - "MasterUsername": "mysqladmin", - "EngineVersion": "5.6.37", - "LicenseModel": "general-public-license", - "SnapshotType": "manual", - "OptionGroupName": "default:mysql-5-6", - "PercentProgress": 100, - "StorageType": "gp2", - "Encrypted": false, - "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", - "IAMDatabaseAuthenticationEnabled": false, - "ProcessorFeatures": [], - "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBSnapshots", - "pageSize": "MaxRecords" - }, - "smithy.api#suppress": [ - "WaitableTraitInvalidErrorType" - ], - "smithy.waiters#waitable": { - "DBSnapshotAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "incompatible-restore", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "incompatible-parameters", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "DBSnapshotDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(DBSnapshots) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "DBSnapshotNotFound" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "resetting-master-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.rds#DescribeDBSnapshotsMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \n
" - } - }, - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A specific DB snapshot identifier to describe.\n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \n
" - } - }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n
    \n
  • \n

    \n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB snapshots that have been marked as public.

    \n
    • \n
  • \n

    \n awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

    \n

    For information about Amazon Web Services Backup, see the \n \n Amazon Web Services Backup Developer Guide.\n \n

    \n

    The awsbackup type does not apply to Aurora.

    \n
    • \n
\n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB snapshots to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-snapshot-id - Accepts DB snapshot identifiers.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts identifiers of source DB instances.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

    \n
    • \n
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "IncludeShared": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "IncludePublic": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A specific DB resource ID to describe.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeDBSubnetGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBSubnetGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBSubnetGroupMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

", - "smithy.api#examples": [ - { - "title": "To describe a DB subnet group", - "documentation": "The following example retrieves the details of the specified DB subnet group.", - "output": { - "DBSubnetGroups": [ - { - "DBSubnetGroupName": "mydbsubnetgroup", - "DBSubnetGroupDescription": "My DB Subnet Group", - "VpcId": "vpc-971c12ee", - "SubnetGroupStatus": "Complete", - "Subnets": [ - { - "SubnetIdentifier": "subnet-d8c8e7f4", - "SubnetAvailabilityZone": { - "Name": "us-east-1a" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-718fdc7d", - "SubnetAvailabilityZone": { - "Name": "us-east-1f" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-cbc8e7e7", - "SubnetAvailabilityZone": { - "Name": "us-east-1a" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-0ccde220", - "SubnetAvailabilityZone": { - "Name": "us-east-1a" - }, - "SubnetStatus": "Active" - } - ], - "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBSubnetGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBSubnetGroupsMessage": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB subnet group to return details for.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeEngineDefaultClusterParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" - }, - "traits": { - "smithy.api#documentation": "

Returns the default engine and system parameter information for the cluster database engine.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

", - "smithy.api#examples": [ - { - "title": "To describe the default engine and system parameter information for the Aurora database engine", - "documentation": "The following example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility.", - "input": { - "DBParameterGroupFamily": "aurora-mysql5.7" - }, - "output": { - "EngineDefaults": { - "Parameters": [ - { - "ParameterName": "aurora_load_from_s3_role", - "Description": "IAM role ARN used to load data from AWS S3", - "Source": "engine-default", - "ApplyType": "dynamic", - "DataType": "string", - "IsModifiable": true, - "SupportedEngineModes": [ - "provisioned" - ] - } - ] - } - } - } - ] - } - }, - "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { - "type": "structure", - "members": { - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group family to return engine parameter information for.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult": { - "type": "structure", - "members": { - "EngineDefaults": { - "target": "com.amazonaws.rds#EngineDefaults" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeEngineDefaultParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEngineDefaultParametersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeEngineDefaultParametersResult" - }, - "traits": { - "smithy.api#documentation": "

Returns the default engine and system parameter information for the specified database engine.

", - "smithy.api#examples": [ - { - "title": "To describe the default engine and system parameter information for the database engine", - "documentation": "The following example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.", - "input": { - "DBParameterGroupFamily": "mysql5.7" - }, - "output": { - "EngineDefaults": { - "Parameters": [ - { - "ParameterName": "allow-suspicious-udfs", - "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", - "Source": "engine-default", - "ApplyType": "static", - "DataType": "boolean", - "AllowedValues": "0,1", - "IsModifiable": false - } - ] - } - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "EngineDefaults.Marker", - "items": "EngineDefaults.Parameters", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeEngineDefaultParametersMessage": { - "type": "structure", - "members": { - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql5.7\n

    \n
    • \n
  • \n

    \n aurora-mysql8.0\n

    \n
    • \n
  • \n

    \n aurora-postgresql10\n

    \n
    • \n
  • \n

    \n aurora-postgresql11\n

    \n
    • \n
  • \n

    \n aurora-postgresql12\n

    \n
    • \n
  • \n

    \n aurora-postgresql13\n

    \n
    • \n
  • \n

    \n aurora-postgresql14\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-19\n

    \n
    • \n
  • \n

    \n mariadb10.2\n

    \n
    • \n
  • \n

    \n mariadb10.3\n

    \n
    • \n
  • \n

    \n mariadb10.4\n

    \n
    • \n
  • \n

    \n mariadb10.5\n

    \n
    • \n
  • \n

    \n mariadb10.6\n

    \n
    • \n
  • \n

    \n mysql5.7\n

    \n
    • \n
  • \n

    \n mysql8.0\n

    \n
    • \n
  • \n

    \n oracle-ee-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-21\n

    \n
    • \n
  • \n

    \n oracle-se2-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-21\n

    \n
    • \n
  • \n

    \n postgres10\n

    \n
    • \n
  • \n

    \n postgres11\n

    \n
    • \n
  • \n

    \n postgres12\n

    \n
    • \n
  • \n

    \n postgres13\n

    \n
    • \n
  • \n

    \n postgres14\n

    \n
    • \n
  • \n

    \n sqlserver-ee-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-15.0\n

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeEngineDefaultParametersResult": { - "type": "structure", - "members": { - "EngineDefaults": { - "target": "com.amazonaws.rds#EngineDefaults" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#DescribeEventCategories": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEventCategoriesMessage" - }, - "output": { - "target": "com.amazonaws.rds#EventCategoriesMessage" - }, - "traits": { - "smithy.api#documentation": "

Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .

", - "smithy.api#examples": [ - { - "title": "To describe event categories", - "documentation": "The following example retrieves details about the event categories for all available event sources.", - "input": { - "SourceType": "", - "Filters": [] - }, - "output": { - "EventCategoriesMapList": [ - { - "SourceType": "db-instance", - "EventCategories": [ - "deletion", - "read replica", - "failover", - "restoration", - "maintenance", - "low storage", - "configuration change", - "backup", - "creation", - "availability", - "recovery", - "failure", - "backtrack", - "notification" - ] - }, - { - "SourceType": "db-security-group", - "EventCategories": [ - "configuration change", - "failure" - ] - }, - { - "SourceType": "db-parameter-group", - "EventCategories": [ - "configuration change" - ] - }, - { - "SourceType": "db-snapshot", - "EventCategories": [ - "deletion", - "creation", - "restoration", - "notification" - ] - }, - { - "SourceType": "db-cluster", - "EventCategories": [ - "failover", - "failure", - "notification" - ] - }, - { - "SourceType": "db-cluster-snapshot", - "EventCategories": [ - "backup" - ] - } - ] - } - } - ] - } - }, - "com.amazonaws.rds#DescribeEventCategoriesMessage": { - "type": "structure", - "members": { - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeEventSubscriptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEventSubscriptionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#EventSubscriptionsMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

\n

If you specify a SubscriptionName, lists the description for that subscription.

", - "smithy.api#examples": [ - { - "title": "To describe event subscriptions", - "documentation": "This example describes all of the Amazon RDS event subscriptions for the current AWS account.", - "output": { - "EventSubscriptionsList": [ - { - "EventCategoriesList": [ - "backup", - "recovery" - ], - "Enabled": true, - "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", - "Status": "creating", - "SourceType": "db-instance", - "CustomerAwsId": "123456789012", - "SubscriptionCreationTime": "2018-07-31 23:22:01.893", - "CustSubscriptionId": "my-instance-events", - "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "EventSubscriptionsList", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeEventSubscriptionsMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription you want to describe.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEventsMessage" - }, - "output": { - "target": "com.amazonaws.rds#EventsMessage" - }, - "traits": { - "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", - "smithy.api#examples": [ - { - "title": "To describe events", - "documentation": "The following retrieves details for the events that have occurred for the specified DB instance.", - "input": { - "SourceIdentifier": "test-instance", - "SourceType": "db-instance" - }, - "output": { - "Events": [ - { - "SourceType": "db-instance", - "SourceIdentifier": "test-instance", - "EventCategories": [ - "backup" - ], - "Message": "Backing up DB instance", - "Date": "2018-07-31T23:09:23.983Z", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" - }, - { - "SourceType": "db-instance", - "SourceIdentifier": "test-instance", - "EventCategories": [ - "backup" - ], - "Message": "Finished DB Instance backup", - "Date": "2018-07-31T23:15:13.049Z", - "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Events", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeEventsMessage": { - "type": "structure", - "members": { - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

\n

Constraints:

\n
    \n
  • \n

    If SourceIdentifier is supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#SourceType", - "traits": { - "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are returned.

" - } - }, - "StartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" - } - }, - "EndTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories that trigger notifications for a event notification subscription.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeExportTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeExportTasksMessage" - }, - "output": { - "target": "com.amazonaws.rds#ExportTasksMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ExportTaskNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a snapshot or cluster export to Amazon S3. This API operation supports\n pagination.

", - "smithy.api#examples": [ - { - "title": "To describe snapshot export tasks", - "documentation": "The following example returns information about snapshot exports to Amazon S3.", - "output": { - "ExportTasks": [ - { - "ExportTaskIdentifier": "test-snapshot-export", - "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot", - "SnapshotTime": "2020-03-02T18:26:28.163Z", - "TaskStartTime": "2020-03-02T18:57:56.896Z", - "TaskEndTime": "2020-03-02T19:10:31.985Z", - "S3Bucket": "mybucket", - "S3Prefix": "", - "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", - "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", - "Status": "COMPLETE", - "PercentProgress": 100, - "TotalExtractedDataInGB": 0 - }, - { - "ExportTaskIdentifier": "my-s3-export", - "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", - "SnapshotTime": "2020-03-27T20:48:42.023Z", - "S3Bucket": "mybucket", - "S3Prefix": "", - "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", - "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", - "Status": "STARTING", - "PercentProgress": 0, - "TotalExtractedDataInGB": 0 - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "ExportTasks", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeExportTasksMessage": { - "type": "structure", - "members": { - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the snapshot or cluster export task to be described.

" - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.

\n

Supported filters include the following:

\n
    \n
  • \n

    \n export-task-identifier - An identifier for the snapshot or cluster export task.

    \n
    • \n
  • \n

    \n s3-bucket - The Amazon S3 bucket the data is exported to.

    \n
    • \n
  • \n

    \n source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

    \n
    • \n
  • \n

    \n status - The status of the export task. Must be lowercase. Valid statuses are the following:

    \n
      \n
    • \n

      \n canceled\n

      \n
      • \n
    • \n

      \n canceling\n

      \n
      • \n
    • \n

      \n complete\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n in_progress\n

      \n
      • \n
    • \n

      \n starting\n

      \n
      • \n
    \n
    • \n
" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#ExportSourceType", - "traits": { - "smithy.api#documentation": "

The type of source for the export.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeGlobalClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeGlobalClustersMessage" - }, - "output": { - "target": "com.amazonaws.rds#GlobalClustersMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about Aurora global database clusters. This API supports pagination.

\n

For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To describe global DB clusters", - "documentation": "The following example lists Aurora global DB clusters in the current AWS Region.", - "output": { - "GlobalClusters": [ - { - "GlobalClusterIdentifier": "myglobalcluster", - "GlobalClusterResourceId": "cluster-f5982077e3b5aabb", - "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", - "Status": "available", - "Engine": "aurora-mysql", - "EngineVersion": "5.7.mysql_aurora.2.07.2", - "StorageEncrypted": false, - "DeletionProtection": false, - "GlobalClusterMembers": [] - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "GlobalClusters", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeGlobalClustersMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBClusterIdentifier.

    \n
    • \n
" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeOptionGroupOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeOptionGroupOptionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#OptionGroupOptionsMessage" - }, - "traits": { - "smithy.api#documentation": "

Describes all available options.

", - "smithy.api#examples": [ - { - "title": "To describe all available options", - "documentation": "The following example lists the options for an RDS for MySQL version 8.0 DB instance.", - "input": { - "EngineName": "mysql", - "MajorEngineVersion": "8.0" - }, - "output": { - "OptionGroupOptions": [ - { - "Name": "MARIADB_AUDIT_PLUGIN", - "Description": "MariaDB Audit Plugin", - "EngineName": "mysql", - "MajorEngineVersion": "8.0", - "MinimumRequiredMinorEngineVersion": "25", - "PortRequired": false, - "OptionsDependedOn": [], - "OptionsConflictsWith": [], - "Persistent": false, - "Permanent": false, - "RequiresAutoMinorEngineVersionUpgrade": false, - "VpcOnly": false, - "OptionGroupOptionSettings": [ - { - "SettingName": "SERVER_AUDIT_INCL_USERS", - "SettingDescription": "Include specified users", - "ApplyType": "DYNAMIC", - "IsModifiable": true, - "IsRequired": false, - "MinimumEngineVersionPerAllowedValue": [] - }, - { - "SettingName": "SERVER_AUDIT_EXCL_USERS", - "SettingDescription": "Exclude specified users", - "ApplyType": "DYNAMIC", - "IsModifiable": true, - "IsRequired": false, - "MinimumEngineVersionPerAllowedValue": [] - } - ] - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "OptionGroupOptions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeOptionGroupOptionsMessage": { - "type": "structure", - "members": { - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If specified, filters the results to include only options for the specified major engine version.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeOptionGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeOptionGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#OptionGroups" - }, - "errors": [ - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available option groups.

", - "smithy.api#examples": [ - { - "title": "To describe the available option groups", - "documentation": "The following example lists the options groups for an Oracle Database 19c instance.", - "input": { - "EngineName": "oracle-ee", - "MajorEngineVersion": "19" - }, - "output": { - "OptionGroupsList": [ - { - "OptionGroupName": "default:oracle-ee-19", - "OptionGroupDescription": "Default option group for oracle-ee 19", - "EngineName": "oracle-ee", - "MajorEngineVersion": "19", - "Options": [], - "AllowsVpcAndNonVpcInstanceMemberships": true, - "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "OptionGroupsList", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeOptionGroupsMessage": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeOrderableDBInstanceOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#OrderableDBInstanceOptionsMessage" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

", - "smithy.api#examples": [ - { - "title": "To describe orderable DB instance options", - "documentation": "The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.", - "input": { - "Engine": "mysql" - }, - "output": { - "OrderableDBInstanceOptions": [ - { - "Engine": "mysql", - "EngineVersion": "5.7.33", - "DBInstanceClass": "db.m4.10xlarge", - "LicenseModel": "general-public-license", - "AvailabilityZones": [ - { - "Name": "us-east-1a" - }, - { - "Name": "us-east-1b" - }, - { - "Name": "us-east-1c" - }, - { - "Name": "us-east-1d" - }, - { - "Name": "us-east-1e" - }, - { - "Name": "us-east-1f" - } - ], - "MultiAZCapable": true, - "ReadReplicaCapable": true, - "Vpc": true, - "SupportsStorageEncryption": true, - "StorageType": "gp2" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "OrderableDBInstanceOptions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" - } - }, - "AvailabilityZoneGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "Vpc": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 10000.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribePendingMaintenanceActions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#PendingMaintenanceActionsMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

", - "smithy.api#examples": [ - { - "title": "To list resources with at least one pending maintenance action", - "documentation": "The following example lists the pending maintenace action for a DB instance.", - "output": { - "PendingMaintenanceActions": [ - { - "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1", - "PendingMaintenanceActionDetails": [ - { - "Action": "system-update", - "Description": "Upgrade to Aurora PostgreSQL 2.4.2" - } - ] - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "PendingMaintenanceActions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage": { - "type": "structure", - "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN of a resource to return pending maintenance actions for.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions for.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance \n actions for the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list only includes pending maintenance \n actions for the DB instances identified by these ARNs.

    \n
    • \n
" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeReservedDBInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeReservedDBInstancesMessage" - }, - "output": { - "target": "com.amazonaws.rds#ReservedDBInstanceMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ReservedDBInstanceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

", - "smithy.api#examples": [ - { - "title": "To describe reserved DB instances", - "documentation": "The following example retrieves details about any reserved DB instances in the current AWS account.", - "output": { - "ReservedDBInstances": [ - { - "ReservedDBInstanceId": "myreservedinstance", - "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456", - "DBInstanceClass": "db.t3.micro", - "StartTime": "2020-06-01T13:44:21.436Z", - "Duration": 31536000, - "FixedPrice": 0, - "UsagePrice": 0, - "CurrencyCode": "USD", - "DBInstanceCount": 1, - "ProductDescription": "sqlserver-ex(li)", - "OfferingType": "No Upfront", - "MultiAZ": false, - "State": "payment-pending", - "RecurringCharges": [ - { - "RecurringChargeAmount": 0.014, - "RecurringChargeFrequency": "Hourly" - } - ], - "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance", - "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "ReservedDBInstances", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeReservedDBInstancesMessage": { - "type": "structure", - "members": { - "ReservedDBInstanceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" - } - }, - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" - } - }, - "OfferingType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" - } - }, - "LeaseId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeReservedDBInstancesOfferings": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage" - }, - "output": { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Lists available reserved DB instance offerings.

", - "smithy.api#examples": [ - { - "title": "To describe reserved DB instance offerings", - "documentation": "The following example retrieves details about reserved DB instance options for RDS for Oracle.", - "input": { - "ProductDescription": "oracle" - }, - "output": { - "ReservedDBInstancesOfferings": [ - { - "CurrencyCode": "USD", - "UsagePrice": 0, - "ProductDescription": "oracle-se2(li)", - "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8", - "MultiAZ": true, - "DBInstanceClass": "db.m4.xlarge", - "OfferingType": "Partial Upfront", - "RecurringCharges": [ - { - "RecurringChargeAmount": 0.594, - "RecurringChargeFrequency": "Hourly" - } - ], - "FixedPrice": 4089, - "Duration": 31536000 - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "ReservedDBInstancesOfferings", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage": { - "type": "structure", - "members": { - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

\n \n

The results show offerings that partially match the filter value.

\n " - } - }, - "OfferingType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeSourceRegions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeSourceRegionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#SourceRegionMessage" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.

\n

Use this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.

\n

To return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.

", - "smithy.api#examples": [ - { - "title": "To describe source Regions", - "documentation": "The following example retrieves details about all source AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. It also shows that automated backups can be replicated only from US West (Oregon) to the destination AWS Region, US East (N. Virginia).", - "input": { - "RegionName": "us-east-1" - }, - "output": { - "SourceRegions": [ - { - "RegionName": "af-south-1", - "Endpoint": "https://rds.af-south-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - }, - { - "RegionName": "ap-east-1", - "Endpoint": "https://rds.ap-east-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - }, - { - "RegionName": "ap-northeast-1", - "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "ap-northeast-2", - "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "ap-northeast-3", - "Endpoint": "https://rds.ap-northeast-3.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - }, - { - "RegionName": "ap-south-1", - "Endpoint": "https://rds.ap-south-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "ap-southeast-1", - "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "ap-southeast-2", - "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "ap-southeast-3", - "Endpoint": "https://rds.ap-southeast-3.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - }, - { - "RegionName": "ca-central-1", - "Endpoint": "https://rds.ca-central-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "eu-north-1", - "Endpoint": "https://rds.eu-north-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "eu-south-1", - "Endpoint": "https://rds.eu-south-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - }, - { - "RegionName": "eu-west-1", - "Endpoint": "https://rds.eu-west-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "eu-west-2", - "Endpoint": "https://rds.eu-west-2.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "eu-west-3", - "Endpoint": "https://rds.eu-west-3.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "me-central-1", - "Endpoint": "https://rds.me-central-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - }, - { - "RegionName": "me-south-1", - "Endpoint": "https://rds.me-south-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": false - }, - { - "RegionName": "sa-east-1", - "Endpoint": "https://rds.sa-east-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "us-east-2", - "Endpoint": "https://rds.us-east-2.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "us-west-1", - "Endpoint": "https://rds.us-west-1.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - }, - { - "RegionName": "us-west-2", - "Endpoint": "https://rds.us-west-2.amazonaws.com", - "Status": "available", - "SupportsDBInstanceAutomatedBackupsReplication": true - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "SourceRegions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeSourceRegionsMessage": { - "type": "structure", - "members": { - "RegionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The source Amazon Web Services Region name. For example, us-east-1.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid Amazon Web Services Region name.

    \n
    • \n
" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeValidDBInstanceModifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.

\n

This command doesn't apply to RDS Custom.

", - "smithy.api#examples": [ - { - "title": "To describe valid modifications for a DB instance", - "documentation": "The following example retrieves details about the valid modifications for the specified DB instance.", - "input": { - "DBInstanceIdentifier": "database-test1" - }, - "output": { - "ValidDBInstanceModificationsMessage": { - "Storage": [ - { - "StorageType": "gp2", - "StorageSize": [ - { - "From": 20, - "To": 20, - "Step": 1 - }, - { - "From": 22, - "To": 6144, - "Step": 1 - } - ] - } - ] - } - } - } - ] - } - }, - "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The customer identifier or the ARN of your DB instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult": { - "type": "structure", - "members": { - "ValidDBInstanceModificationsMessage": { - "target": "com.amazonaws.rds#ValidDBInstanceModificationsMessage" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.rds#DomainMembership": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the Active Directory Domain.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

" - } - }, - "FQDN": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the Active Directory Domain.

" - } - }, - "IAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role used when making API calls to the Directory Service.

" - } - }, - "OU": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory organizational unit for the DB instance or cluster.

" - } - }, - "AuthSecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

" - } - }, - "DnsIps": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Active Directory Domain membership record associated with the DB instance or cluster.

" - } - }, - "com.amazonaws.rds#DomainMembershipList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DomainMembership", - "traits": { - "smithy.api#xmlName": "DomainMembership" - } - } - }, - "com.amazonaws.rds#DomainNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DomainNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n Domain doesn't refer to an existing Active Directory domain.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#Double": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.rds#DoubleOptional": { - "type": "double" - }, - "com.amazonaws.rds#DoubleRange": { - "type": "structure", - "members": { - "From": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum value in the range.

" - } - }, - "To": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum value in the range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A range of double values.

" - } - }, - "com.amazonaws.rds#DoubleRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DoubleRange", - "traits": { - "smithy.api#xmlName": "DoubleRange" - } - } - }, - "com.amazonaws.rds#DownloadDBLogFilePortion": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DownloadDBLogFilePortionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DownloadDBLogFilePortionDetails" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBLogFileNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

\n

This command doesn't apply to RDS Custom.

", - "smithy.api#examples": [ - { - "title": "To download a DB log file", - "documentation": "The following example downloads only the latest part of your log file.", - "input": { - "DBInstanceIdentifier": "test-instance", - "LogFileName": "log.txt" - }, - "output": {} - } - ], - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "NumberOfLines" - } - } - }, - "com.amazonaws.rds#DownloadDBLogFilePortionDetails": { - "type": "structure", - "members": { - "LogFileData": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Entries from the specified log file.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DownloadDBLogFilePortion request.

" - } - }, - "AdditionalDataPending": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value that if true, indicates there is more data to be downloaded.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element to DownloadDBLogFilePortion.

" - } - }, - "com.amazonaws.rds#DownloadDBLogFilePortionMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "LogFileName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the log file to be downloaded.

", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

" - } - }, - "NumberOfLines": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

\n

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

\n
    \n
  • \n

    If neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.

    \n
    • \n
  • \n

    If \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.

    \n
    • \n
  • \n

    If Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.

    \n
    • \n
  • \n

    You can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#EC2SecurityGroup": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" - } - }, - "EC2SecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the EC2 security group.

" - } - }, - "EC2SecurityGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the id of the EC2 security group.

" - } - }, - "EC2SecurityGroupOwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n AuthorizeDBSecurityGroupIngress\n

    \n
    • \n
  • \n

    \n DescribeDBSecurityGroups\n

    \n
    • \n
  • \n

    \n RevokeDBSecurityGroupIngress\n

    \n
    • \n
" - } - }, - "com.amazonaws.rds#EC2SecurityGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#EC2SecurityGroup", - "traits": { - "smithy.api#xmlName": "EC2SecurityGroup" - } - } - }, - "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "Ec2ImagePropertiesNotSupportedFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The AMI configuration prerequisite has not been met.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#Endpoint": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the DNS address of the DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
\n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" - } - }, - "com.amazonaws.rds#EngineDefaults": { - "type": "structure", - "members": { - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the DB parameter group family that the engine default parameters apply to.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

Contains a list of engine default parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" - } - }, - "com.amazonaws.rds#EngineFamily": { - "type": "enum", - "members": { - "MYSQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MYSQL" - } - }, - "POSTGRESQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRESQL" - } - }, - "SQLSERVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQLSERVER" - } - } - } - }, - "com.amazonaws.rds#EngineModeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#Event": { - "type": "structure", - "members": { - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the identifier for the source of the event.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#SourceType", - "traits": { - "smithy.api#documentation": "

Specifies the source type for this event.

" - } - }, - "Message": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the text of this event.

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

Specifies the category for the event.

" - } - }, - "Date": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the date and time of the event.

" - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeEvents action.

" - } - }, - "com.amazonaws.rds#EventCategoriesList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "EventCategory" - } - } - }, - "com.amazonaws.rds#EventCategoriesMap": { - "type": "structure", - "members": { - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The source type that the returned categories belong to

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

The event categories for the specified source type

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventCategories\n operation.

" - } - }, - "com.amazonaws.rds#EventCategoriesMapList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#EventCategoriesMap", - "traits": { - "smithy.api#xmlName": "EventCategoriesMap" - } - } - }, - "com.amazonaws.rds#EventCategoriesMessage": { - "type": "structure", - "members": { - "EventCategoriesMapList": { - "target": "com.amazonaws.rds#EventCategoriesMapList", - "traits": { - "smithy.api#documentation": "

A list of EventCategoriesMap data types.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned from the DescribeEventCategories operation.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#EventList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Event", - "traits": { - "smithy.api#xmlName": "Event" - } - } - }, - "com.amazonaws.rds#EventSubscription": { - "type": "structure", - "members": { - "CustomerAwsId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services customer account associated with the RDS event notification subscription.

" - } - }, - "CustSubscriptionId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The RDS event notification subscription Id.

" - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The topic ARN of the RDS event notification subscription.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" - } - }, - "SubscriptionCreationTime": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time the RDS event notification subscription was created.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The source type for the RDS event notification subscription.

" - } - }, - "SourceIdsList": { - "target": "com.amazonaws.rds#SourceIdsList", - "traits": { - "smithy.api#documentation": "

A list of source IDs for the RDS event notification subscription.

" - } - }, - "EventCategoriesList": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories for the RDS event notification subscription.

" - } - }, - "Enabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" - } - }, - "EventSubscriptionArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event subscription.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" - } - }, - "com.amazonaws.rds#EventSubscriptionQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "EventSubscriptionQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have reached the maximum number of event subscriptions.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#EventSubscriptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#EventSubscription", - "traits": { - "smithy.api#xmlName": "EventSubscription" - } - } - }, - "com.amazonaws.rds#EventSubscriptionsMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "EventSubscriptionsList": { - "target": "com.amazonaws.rds#EventSubscriptionsList", - "traits": { - "smithy.api#documentation": "

A list of EventSubscriptions data types.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned by the DescribeEventSubscriptions action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#EventsMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords.

" - } - }, - "Events": { - "target": "com.amazonaws.rds#EventList", - "traits": { - "smithy.api#documentation": "

A list of Event instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEvents action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ExceptionMessage": { - "type": "string" - }, - "com.amazonaws.rds#ExportSourceType": { - "type": "enum", - "members": { - "SNAPSHOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNAPSHOT" - } - }, - "CLUSTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER" - } - } - } - }, - "com.amazonaws.rds#ExportTask": { - "type": "structure", - "members": { - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for\n the Amazon S3 bucket where the data is exported.

" - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

" - } - }, - "ExportOnly": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The data exported from the snapshot or cluster. Valid values are the following:

\n
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
" - } - }, - "SnapshotTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time that the snapshot was created.

" - } - }, - "TaskStartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time that the snapshot or cluster export task started.

" - } - }, - "TaskEndTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time that the snapshot or cluster export task ended.

" - } - }, - "S3Bucket": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket that the snapshot or cluster is exported to.

" - } - }, - "S3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket prefix that is the file name and path of the exported data.

" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. \n The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export\n must have encryption and decryption permissions to use this KMS key.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The progress status of the export task. The status can be one of the following:

\n
    \n
  • \n

    \n CANCELED\n

    \n
    • \n
  • \n

    \n CANCELING\n

    \n
    • \n
  • \n

    \n COMPLETE\n

    \n
    • \n
  • \n

    \n FAILED\n

    \n
    • \n
  • \n

    \n IN_PROGRESS\n

    \n
    • \n
  • \n

    \n STARTING\n

    \n
    • \n
" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress of the snapshot or cluster export task as a percentage.

" - } - }, - "TotalExtractedDataInGB": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total amount of data exported, in gigabytes.

" - } - }, - "FailureCause": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The reason the export failed, if it failed.

" - } - }, - "WarningMessage": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A warning about the snapshot or cluster export task.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#ExportSourceType", - "traits": { - "smithy.api#documentation": "

The type of source for the export.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of a snapshot or cluster export to Amazon S3.

\n

This data type is used as a response element in the DescribeExportTasks action.

" - } - }, - "com.amazonaws.rds#ExportTaskAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ExportTaskAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't start an export task that's already running.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#ExportTaskNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ExportTaskNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The export task doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#ExportTasksList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ExportTask", - "traits": { - "smithy.api#xmlName": "ExportTask" - } - } - }, - "com.amazonaws.rds#ExportTasksMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeExportTasks\n request. A marker is used for pagination to identify the location to begin output for\n the next response of DescribeExportTasks.

" - } - }, - "ExportTasks": { - "target": "com.amazonaws.rds#ExportTasksList", - "traits": { - "smithy.api#documentation": "

Information about an export of a snapshot or cluster to Amazon S3.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#FailoverDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#FailoverDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#FailoverDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Forces a failover for a DB cluster.

\n

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.

\n

To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To perform a failover for a DB cluster", - "documentation": "This example performs a failover for the specified DB cluster to the specified DB instance.", - "input": { - "DBClusterIdentifier": "myaurorainstance-cluster", - "TargetDBInstanceIdentifier": "myaurorareplica" - }, - "output": { - "DBCluster": {} - } - } - ] - } - }, - "com.amazonaws.rds#FailoverDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "TargetDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB instance to promote to the primary DB instance.

\n

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.

\n

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#FailoverDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#FailoverGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#FailoverGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#FailoverGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Initiates the failover process for an Aurora global database (GlobalCluster).

\n

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be\n the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,\n the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected\n secondary DB cluster assumes full read/write capabilities for the Aurora global database.

\n

For more information about failing over an Amazon Aurora global database, see\n Managed planned failover for Amazon Aurora global\n databases in the Amazon Aurora User Guide.

\n \n

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on\n healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to\n reconfigure your Aurora global database topology.

\n " - } - }, - "com.amazonaws.rds#FailoverGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#GlobalClusterIdentifier", - "traits": { - "smithy.api#documentation": "

Identifier of the Aurora global database (GlobalCluster)\n that should be failed over. The identifier is the unique key assigned by\n the user when the Aurora global database was created. In other words,\n it's the name of the Aurora global database that you want to fail over.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing\n GlobalCluster (Aurora global database).

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "TargetDbClusterIdentifier": { - "target": "com.amazonaws.rds#DBClusterIdentifier", - "traits": { - "smithy.api#documentation": "

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora\n global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#FailoverGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#FailoverState": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.rds#FailoverStatus", - "traits": { - "smithy.api#documentation": "

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

\n
    \n
  • \n

    pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The\n GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover\n process can start.

    \n
    • \n
  • \n

    failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such\n as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

    \n
    • \n
  • \n

    cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary\n Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

    \n
    • \n
" - } - }, - "FromDbClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this\n state.

" - } - }, - "ToDbClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated\n with this state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the state of scheduled or in-process failover operations on an\n Aurora global database (GlobalCluster). This Data type is empty unless a failover\n operation is scheduled or is currently underway on the Aurora global database.

" - } - }, - "com.amazonaws.rds#FailoverStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "FAILING_OVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failing-over" - } - }, - "CANCELLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelling" - } - } - } - }, - "com.amazonaws.rds#FeatureNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#Filter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.rds#FilterValueList", - "traits": { - "smithy.api#documentation": "

One or more filter values. Filter values are case-sensitive.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.

\n \n

Currently, wildcards are not supported in filters.

\n \n

The following actions can be filtered:

\n
    \n
  • \n

    \n DescribeDBClusterBacktracks\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n DescribeDBClusters\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribePendingMaintenanceActions\n

    \n
    • \n
" - } - }, - "com.amazonaws.rds#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Filter", - "traits": { - "smithy.api#xmlName": "Filter" - } - } - }, - "com.amazonaws.rds#FilterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "Value" - } - } - }, - "com.amazonaws.rds#GlobalCluster": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.

" - } - }, - "GlobalClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

" - } - }, - "GlobalClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the global database cluster.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the current state of this global database cluster.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Aurora database engine used by the global database cluster.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The default database name within the new global database cluster.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

The storage encryption setting for the global database cluster.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

The deletion protection setting for the new global database cluster.

" - } - }, - "GlobalClusterMembers": { - "target": "com.amazonaws.rds#GlobalClusterMemberList", - "traits": { - "smithy.api#documentation": "

The list of primary and secondary clusters within the global database cluster.

" - } - }, - "FailoverState": { - "target": "com.amazonaws.rds#FailoverState", - "traits": { - "smithy.api#documentation": "

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database.\n This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A data type representing an Aurora global database.

" - } - }, - "com.amazonaws.rds#GlobalClusterAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "GlobalClusterAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#GlobalClusterIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" - } - }, - "com.amazonaws.rds#GlobalClusterList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#GlobalCluster", - "traits": { - "smithy.api#xmlName": "GlobalClusterMember" - } - } - }, - "com.amazonaws.rds#GlobalClusterMember": { - "type": "structure", - "members": { - "DBClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each Aurora cluster.

" - } - }, - "Readers": { - "target": "com.amazonaws.rds#ReadersArnList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the Aurora global database.

" - } - }, - "IsWriter": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.

" - } - }, - "GlobalWriteForwardingStatus": { - "target": "com.amazonaws.rds#WriteForwardingStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A data structure with information about any primary and\n secondary clusters associated with an Aurora global database.

" - } - }, - "com.amazonaws.rds#GlobalClusterMemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#GlobalClusterMember", - "traits": { - "smithy.api#xmlName": "GlobalClusterMember" - } - } - }, - "com.amazonaws.rds#GlobalClusterNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "GlobalClusterNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#GlobalClusterQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "GlobalClusterQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The number of global database clusters for this account is already at the maximum allowed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#GlobalClustersMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

" - } - }, - "GlobalClusters": { - "target": "com.amazonaws.rds#GlobalClusterList", - "traits": { - "smithy.api#documentation": "

The list of global clusters returned by this request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#IAMAuthMode": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REQUIRED" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - } - } - }, - "com.amazonaws.rds#IPRange": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" - } - }, - "CIDRIP": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the IP range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBSecurityGroups action.

" - } - }, - "com.amazonaws.rds#IPRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#IPRange", - "traits": { - "smithy.api#xmlName": "IPRange" - } - } - }, - "com.amazonaws.rds#IamRoleMissingPermissionsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "IamRoleMissingPermissions", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The IAM role requires additional permissions to export to an Amazon S3 bucket.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#IamRoleNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "IamRoleNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The IAM role is missing for exporting to an Amazon S3 bucket.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#InstanceQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InstanceQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n instances.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientAvailableIPsInSubnetFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested operation can't be performed because there aren't enough available IP addresses \n in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required \n from the subnets.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InsufficientDBClusterCapacityFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientDBClusterCapacityFault", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

The DB cluster doesn't have enough capacity for the current operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.rds#InsufficientDBInstanceCapacityFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientDBInstanceCapacity", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified DB instance class isn't available in the specified Availability\n Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InsufficientStorageClusterCapacityFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientStorageClusterCapacity", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

There is insufficient storage available for the current action. You might be able to\n resolve this error by updating your subnet group to use different Availability Zones\n that have more storage available.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.rds#IntegerOptional": { - "type": "integer" - }, - "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidBlueGreenDeploymentStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in \n the green environment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidCustomDBEngineVersionStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't delete the CEV.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterAutomatedBackupStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterCapacityFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterCapacityFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n Capacity isn't a valid Aurora Serverless DB cluster\n capacity. Valid capacity values are 2, 4, 8, 16, \n 32, 64, 128, and 256.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterEndpointStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterEndpointStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested operation can't be performed on the endpoint while the endpoint is in this state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterSnapshotStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The supplied value isn't a valid DB cluster snapshot state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested operation can't be performed while the cluster is in this state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBInstanceAutomatedBackupState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBInstanceStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBInstanceState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB instance isn't in a valid state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBParameterGroupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBParameterGroupState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB parameter group is in use or is in an invalid state. If you are attempting\n to delete the parameter group, you can't delete it when the parameter group is in\n this state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBProxyEndpointStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBProxyEndpointStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't perform this operation while the DB proxy endpoint is in a particular state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBProxyStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBProxyStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested operation can't be performed while the proxy is in this state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSecurityGroupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSecurityGroupState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The state of the DB security group doesn't allow deletion.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSnapshotStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSnapshotState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The state of the DB snapshot doesn't allow deletion.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSubnetGroupFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSubnetGroupFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DBSubnetGroup doesn't belong to the same VPC as that of an existing\n cross-region read replica of the same source instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSubnetGroupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSubnetGroupStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB subnet group cannot be deleted because it's in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSubnetStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSubnetStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB subnet isn't in the available state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidEventSubscriptionStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidEventSubscriptionState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This error can occur if someone else is modifying a subscription. You should retry the action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidExportOnlyFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidExportOnly", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The export is invalid for exporting to an Amazon S3 bucket.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidExportSourceStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidExportSourceState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidExportTaskStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidExportTaskStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't cancel an export task that has completed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidGlobalClusterStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidGlobalClusterStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidOptionGroupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidOptionGroupStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The option group isn't in the available state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidRestoreFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidRestoreFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Cannot restore from VPC backup to non-VPC DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidS3BucketFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidS3BucketFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't\n authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidSubnet": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidSubnet", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidVPCNetworkStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidVPCNetworkStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB subnet group doesn't cover all Availability Zones after it's\n created because of users' change.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#KMSKeyNotAccessibleFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "KMSKeyNotAccessibleFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

An error occurred accessing an Amazon Web Services KMS key.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#KeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#KmsKeyIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_:\\-\\/]+$" - } - }, - "com.amazonaws.rds#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ListTagsForResourceMessage" - }, - "output": { - "target": "com.amazonaws.rds#TagListMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all tags on an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.

", - "smithy.api#examples": [ - { - "title": "To list tags on an Amazon RDS resource", - "documentation": "The following example lists all tags on a DB instance.", - "input": { - "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:orcl1" - }, - "output": { - "TagList": [ - { - "Key": "Environment", - "Value": "test" - }, - { - "Key": "Name", - "Value": "MyDatabase" - } - ] - } - } - ] - } - }, - "com.amazonaws.rds#ListTagsForResourceMessage": { - "type": "structure", - "members": { - "ResourceName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#LocalWriteForwardingStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "ENABLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabling" - } - }, - "DISABLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabling" - } - }, - "REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "requested" - } - } - } - }, - "com.amazonaws.rds#LogTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#Long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.rds#LongOptional": { - "type": "long" - }, - "com.amazonaws.rds#MasterUserSecret": { - "type": "structure", - "members": { - "SecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" - } - }, - "SecretStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the secret.

\n

The possible status values include the following:

\n
    \n
  • \n

    \n creating - The secret is being created.

    \n
    • \n
  • \n

    \n active - The secret is available for normal use and rotation.

    \n
    • \n
  • \n

    \n rotating - The secret is being rotated.

    \n
    • \n
  • \n

    \n impaired - The secret can be used to access database credentials,\n but it can't be rotated. A secret might have this status if, for example,\n permissions are changed so that RDS can no longer access either the secret or\n the KMS key for the secret.

    \n

    When a secret has this status, you can correct the condition that caused the\n status. Alternatively, modify the DB instance to turn off automatic management\n of database credentials, and then modify the DB instance again to turn on\n automatic management of database credentials.

    \n
    • \n
" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" - } - }, - "com.amazonaws.rds#MaxRecords": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 20, - "max": 100 - } - } - }, - "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue": { - "type": "structure", - "members": { - "AllowedValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The allowed value for an option setting.

" - } - }, - "MinimumEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The minimum DB engine version required for the allowed value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum DB engine version required for each corresponding allowed value for an option setting.

" - } - }, - "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue", - "traits": { - "smithy.api#xmlName": "MinimumEngineVersionPerAllowedValue" - } - } - }, - "com.amazonaws.rds#ModifyActivityStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyActivityStreamRequest" - }, - "output": { - "target": "com.amazonaws.rds#ModifyActivityStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.

\n

This operation is supported for RDS for Oracle and Microsoft SQL Server.

" - } - }, - "com.amazonaws.rds#ModifyActivityStreamRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.\n For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

" - } - }, - "AuditPolicyState": { - "target": "com.amazonaws.rds#AuditPolicyState", - "traits": { - "smithy.api#documentation": "

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is\n read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyActivityStreamResponse": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" - } - }, - "KinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the modification to the database activity stream.

" - } - }, - "Mode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

The mode of the database activity stream.

" - } - }, - "EngineNativeAuditFieldsIncluded": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" - } - }, - "PolicyStatus": { - "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", - "traits": { - "smithy.api#documentation": "

The status of the modification to the policy state of the database activity stream.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyCertificates": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyCertificatesMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyCertificatesResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CertificateNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n
    \n
  • \n

    You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.

    \n
    • \n
  • \n

    RDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.

    \n
    • \n
\n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

", - "smithy.api#examples": [ - { - "title": "To temporarily override the system-default SSL/TLS certificate for new DB instances", - "documentation": "The following example temporarily overrides the system-default SSL/TLS certificate for new DB instances.", - "input": { - "CertificateIdentifier": "rds-ca-2019" - }, - "output": { - "Certificate": { - "CertificateIdentifier": "rds-ca-2019", - "CertificateType": "CA", - "Thumbprint": "EXAMPLE123456789012", - "ValidFrom": "2019-09-19T18:16:53Z", - "ValidTill": "2024-08-22T17:08:50Z", - "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019", - "CustomerOverride": true, - "CustomerOverrideValidTill": "2024-08-22T17:08:50Z" - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyCertificatesMessage": { - "type": "structure", - "members": { - "CertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.

" - } - }, - "RemoveCustomerOverride": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyCertificatesResult": { - "type": "structure", - "members": { - "Certificate": { - "target": "com.amazonaws.rds#Certificate" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyCurrentDBClusterCapacity": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterCapacityInfo" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

\n

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

\n \n \n

This action only applies to Aurora Serverless v1 DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To scale the capacity of an Aurora Serverless DB cluster", - "documentation": "The following example scales the capacity of an Aurora Serverless DB cluster to 8.", - "input": { - "DBClusterIdentifier": "mydbcluster", - "Capacity": 8 - }, - "output": { - "DBClusterIdentifier": "mydbcluster", - "PendingCapacity": 8, - "CurrentCapacity": 1, - "SecondsBeforeTimeout": 300, - "TimeoutAction": "ForceApplyCapacityChange" - } - } - ] - } - }, - "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Capacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The DB cluster capacity.

\n

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

\n

Constraints:

\n
    \n
  • \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n
    • \n
  • \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n
    • \n
" - } - }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

\n

Specify a value between 10 and 600 seconds.

" - } - }, - "TimeoutAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyCustomDBEngineVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBEngineVersion" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.

\n \n

For more information, see Modifying CEV status \n in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#CustomEngineName", - "traits": { - "smithy.api#documentation": "

The DB engine. The only supported values are custom-oracle-ee and custom-oracle-ee-cdb.

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#CustomEngineVersion", - "traits": { - "smithy.api#documentation": "

The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.rds#Description", - "traits": { - "smithy.api#documentation": "

An optional description of your CEV.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#CustomEngineVersionStatus", - "traits": { - "smithy.api#documentation": "

The availability status to be assigned to the CEV. Valid values are as follows:

\n
\n
available
\n
\n

You can use this CEV to create a new RDS Custom DB instance.

\n
\n
inactive
\n
\n

You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.

\n
\n
\n

You can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotAvailableFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", - "smithy.api#examples": [ - { - "title": "To modify a DB cluster", - "documentation": "The following example changes the master user password for the DB cluster named cluster-2 and sets the backup retention period to 14 days. The ApplyImmediately parameter causes the changes to be made immediately, instead of waiting until the next maintenance window.", - "input": { - "DBClusterIdentifier": "cluster-2", - "ApplyImmediately": true, - "BackupRetentionPeriod": 14, - "MasterUserPassword": "newpassword99" - }, - "output": { - "DBCluster": { - "AllocatedStorage": 1, - "AvailabilityZones": [ - "eu-central-1b", - "eu-central-1c", - "eu-central-1a" - ], - "BackupRetentionPeriod": 14, - "DatabaseName": "", - "DBClusterIdentifier": "cluster-2", - "DBClusterParameterGroup": "default.aurora5.6", - "DBSubnetGroup": "default-vpc-2305ca49", - "Status": "available", - "EarliestRestorableTime": "2020-06-03T02:07:29.637Z", - "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com", - "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com", - "MultiAZ": false, - "Engine": "aurora", - "EngineVersion": "5.6.10a", - "LatestRestorableTime": "2020-06-04T15:11:25.748Z", - "Port": 3306, - "MasterUsername": "admin", - "PreferredBackupWindow": "01:55-02:25", - "PreferredMaintenanceWindow": "thu:21:14-thu:21:44", - "ReadReplicaIdentifiers": [], - "DBClusterMembers": [ - { - "DBInstanceIdentifier": "cluster-2-instance-1", - "IsClusterWriter": true, - "DBClusterParameterGroupStatus": "in-sync", - "PromotionTier": 1 - } - ], - "VpcSecurityGroups": [ - { - "VpcSecurityGroupId": "sg-20a5c047", - "Status": "active" - } - ], - "HostedZoneId": "Z1RLNU0EXAMPLE", - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6", - "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE", - "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2", - "AssociatedRoles": [], - "IAMDatabaseAuthenticationEnabled": false, - "ClusterCreateTime": "2020-04-03T14:44:02.764Z", - "EngineMode": "provisioned", - "DeletionProtection": false, - "HttpEndpointEnabled": false, - "CopyTagsToSnapshot": true, - "CrossAccountClone": false, - "DomainMemberships": [] - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBClusterEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBClusterEndpointMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterEndpoint" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To modify a custom DB cluster endpoint", - "documentation": "The following example modifies the specified custom DB cluster endpoint.", - "input": { - "DBClusterEndpointIdentifier": "mycustomendpoint", - "StaticMembers": [ - "dbinstance1", - "dbinstance2", - "dbinstance3" - ] - }, - "output": { - "DBClusterEndpointIdentifier": "mycustomendpoint", - "DBClusterIdentifier": "mydbcluster", - "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", - "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", - "Status": "modifying", - "EndpointType": "CUSTOM", - "CustomEndpointType": "READER", - "StaticMembers": [ - "dbinstance1", - "dbinstance2", - "dbinstance3" - ], - "ExcludedMembers": [], - "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBClusterEndpointMessage": { - "type": "structure", - "members": { - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

", - "smithy.api#required": {} - } - }, - "EndpointType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, ANY.

" - } - }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" - } - }, - "ExcludedMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "NewDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster2\n

" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are \n asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting \n for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next \n maintenance window.

\n

Most modifications can be applied immediately or during the next scheduled maintenance window. Some \n modifications, such as turning on deletion protection and changing the master password, are applied \n immediately—regardless of when you choose to apply them.

\n

By default, this parameter is disabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35.

    \n
    • \n
" - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: 1150-65535\n

\n

Default: The same port as the original DB cluster.

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group to associate the DB cluster with.

\n

DB clusters are associated with a default option group that can't be modified.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Valid for Cluster Type: Aurora MySQL DB clusters only

\n

Default: 0\n

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" - } - }, - "CloudwatchLogsExportConfiguration": { - "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
\n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless ApplyImmediately is enabled.

\n

If the cluster that you're modifying has one or more read replicas, all replicas must\n be running an engine version that's the same or later than the version you\n specify.

\n

To list all of the available engine versions for Aurora MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query\n \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether major version upgrades are allowed.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Constraints:

\n
    \n
  • \n

    You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

    \n
    • \n
" - } - }, - "DBInstanceParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Valid for Cluster Type: Aurora DB clusters only

\n

Default: The existing name setting

\n

Constraints:

\n
    \n
  • \n

    The DB parameter group must be in the same DB parameter group family as this DB cluster.

    \n
    • \n
  • \n

    The DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.

    \n
    • \n
" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableHttpEndpoint": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableGlobalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    Aurora DB clusters - aurora | aurora-iopt1\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
\n

Default:

\n
    \n
  • \n

    Aurora DB clusters - aurora\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

    \n
    • \n
" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "RotateMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    You must apply the change immediately when rotating the master user password.

    \n
    • \n
" - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n
    \n
  • \n

    The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.

    \n

    If the DB cluster already manages the master user password in Amazon Web Services Secrets\n Manager, you can't change the KMS key that is used to encrypt the secret.

    \n
    • \n
  • \n

    You are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.

    \n

    If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

    \n
    • \n
\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n \n

The DB engine mode can be modified only from serverless to provisioned.

\n \n

For more information, see \n CreateDBCluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" - } - }, - "AllowEngineModeChange": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether engine mode changes from serverless to provisioned \n are allowed.

\n

Valid for Cluster Type: Aurora Serverless v1 DB clusters only

\n

Constraints:

\n
    \n
  • \n

    You must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.

    \n
    • \n
" - } - }, - "EnableLocalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", - "smithy.api#examples": [ - { - "title": "To modify parameters in a DB cluster parameter group", - "documentation": "The following example modifies the values of parameters in a DB cluster parameter group.", - "input": { - "DBClusterParameterGroupName": "mydbclusterpg", - "Parameters": [ - { - "ParameterName": "server_audit_logging", - "ParameterValue": "1", - "ApplyMethod": "immediate" - }, - { - "ParameterName": "server_audit_logs_upload", - "ParameterValue": "1", - "ApplyMethod": "immediate" - } - ] - }, - "output": { - "DBClusterParameterGroupName": "mydbclusterpg" - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to modify.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

", - "smithy.api#examples": [ - { - "title": "To modify a DB cluster snapshot attribute", - "documentation": "The following example makes changes to the specified DB cluster snapshot attribute.", - "input": { - "DBClusterSnapshotIdentifier": "myclustersnapshot", - "AttributeName": "restore", - "ValuesToAdd": [ - "123456789012" - ] - }, - "output": { - "DBClusterSnapshotAttributesResult": { - "DBClusterSnapshotIdentifier": "myclustersnapshot", - "DBClusterSnapshotAttributes": [ - { - "AttributeName": "restore", - "AttributeValues": [ - "123456789012" - ] - } - ] - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB cluster snapshot to modify the attributes for.

", - "smithy.api#required": {} - } - }, - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.

\n ", - "smithy.api#required": {} - } - }, - "ValuesToAdd": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" - } - }, - "ValuesToRemove": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult": { - "type": "structure", - "members": { - "DBClusterSnapshotAttributesResult": { - "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#CertificateNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBUpgradeDependencyFailureFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.

", - "smithy.api#examples": [ - { - "title": "To modify a DB instance", - "documentation": "The following example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ApplyImmediately parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.", - "input": { - "DBInstanceIdentifier": "database-2", - "ApplyImmediately": true, - "DBParameterGroupName": "test-sqlserver-se-2017", - "OptionGroupName": "test-se-2017" - }, - "output": { - "DBInstance": { - "DBInstanceIdentifier": "database-2", - "DBInstanceClass": "db.r4.large", - "Engine": "sqlserver-se", - "DBInstanceStatus": "available", - "DBParameterGroups": [ - { - "DBParameterGroupName": "test-sqlserver-se-2017", - "ParameterApplyStatus": "applying" - } - ], - "AvailabilityZone": "us-west-2d", - "MultiAZ": true, - "EngineVersion": "14.00.3281.6.v1", - "AutoMinorVersionUpgrade": false, - "ReadReplicaDBInstanceIdentifiers": [], - "LicenseModel": "license-included", - "OptionGroupMemberships": [ - { - "OptionGroupName": "test-se-2017", - "Status": "pending-apply" - } - ], - "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS", - "SecondaryAvailabilityZone": "us-west-2c", - "PubliclyAccessible": true, - "StorageType": "gp2", - "DeletionProtection": false, - "AssociatedRoles": [], - "MaxAllocatedStorage": 1000 - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of DB instance to modify. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB instance.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.

\n

Default: Uses existing setting

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This parameter doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing DB subnet group.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing DB security groups.

    \n
    • \n
" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing VPC security group IDs.

    \n
    • \n
" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n \n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
    • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
    • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
    • \n
" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be in the same DB parameter group family as the DB instance.

    \n
    • \n
" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to \n read replicas.

    \n
    • \n
  • \n

    Can't be set to 0 for an RDS Custom for Oracle DB instance.

    \n
    • \n
" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter causes a reboot\n of the DB instance. If you change this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    The day values must be mon | tue | wed | thu | fri | sat | sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.

" - } - }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that's a different major version than the DB instance's current version.

    \n
    • \n
" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n
    \n
  • \n

    The automatic upgrade is enabled for the maintenance window.

    \n
    • \n
  • \n

    A newer minor version is available.

    \n
    • \n
  • \n

    RDS has enabled automatic patching for the engine version.

    \n
    • \n
\n

If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
    • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
    • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
    • \n
" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Constraints:

\n
    \n
  • \n

    For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    \n
    • \n
\n

Default: Uses existing setting

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group to associate the DB instance with.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "NewDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "DomainFqdn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" - } - }, - "DomainOu": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" - } - }, - "DomainAuthSecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" - } - }, - "DomainDnsIps": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" - } - }, - "DBPortNumber": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    Amazon Aurora - 3306\n

    \n
    • \n
  • \n

    RDS for MariaDB - 3306\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - 1433\n

    \n
    • \n
  • \n

    RDS for MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for Oracle - 1521\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - 5432\n

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    For RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.

    \n
    • \n
" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "DisableDomain": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to remove the DB instance from the Active Directory domain.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: 1\n

\n

Valid Values: 0 - 15\n

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" - } - }, - "CloudwatchLogsExportConfiguration": { - "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", - "traits": { - "smithy.api#documentation": "

The log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "CertificateRotationRestart": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "ReplicaMode": { - "target": "com.amazonaws.rds#ReplicaMode", - "traits": { - "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "AwsBackupRecoveryPointArn": { - "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "AutomationMode": { - "target": "com.amazonaws.rds#AutomationMode", - "traits": { - "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.

" - } - }, - "ResumeFullAutomationModeMinutes": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation.

\n

Default: 60\n

\n

Constraints:

\n
    \n
  • \n

    Must be at least 60.

    \n
    • \n
  • \n

    Must be no more than 1,440.

    \n
    • \n
" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" - } - }, - "RotateMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    You must apply the change immediately when rotating the master user password.

    \n
    • \n
" - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n
    \n
  • \n

    The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.

    \n

    If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, \n you can't change the KMS key used to encrypt the secret.

    \n
    • \n
  • \n

    You are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.

    \n

    If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

    \n
    • \n
\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB\n to an Oracle Database 21c CDB.

\n

Note the following requirements:

\n
    \n
  • \n

    Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.

    \n
    • \n
  • \n

    Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.

    \n
    • \n
\n

Note the following limitations:

\n
    \n
  • \n

    You can't convert a CDB to a non-CDB.

    \n
    • \n
  • \n

    You can't convert a replica database.

    \n
    • \n
  • \n

    You can't convert a non-CDB to a CDB and upgrade the engine version in the\n same command.

    \n
    • \n
  • \n

    You can't convert the existing custom parameter or option group when it has\n options or parameters that are permanent or persistent. In this situation, the\n DB instance reverts to the default option and parameter group. To avoid\n reverting to the default, specify a new parameter group with\n --db-parameter-group-name and a new option group with\n --option-group-name.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBParameterGroupNameMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n ", - "smithy.api#examples": [ - { - "title": "To modify a DB parameter group", - "documentation": "The following example changes the value of the clr enabled parameter in a DB parameter group. The value of the ApplyMethod parameter causes the DB parameter group to be modified immediately, instead of waiting until the next maintenance window.", - "input": { - "DBParameterGroupName": "test-sqlserver-se-2017", - "Parameters": [ - { - "ParameterName": "clr enabled", - "ParameterValue": "1", - "ApplyMethod": "immediate" - } - ] - }, - "output": { - "DBParameterGroupName": "test-sqlserver-se-2017" - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBParameterGroupMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.

\n

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.

\n \n

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

\n \n

For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBProxy": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBProxyRequest" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBProxyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Changes the settings for an existing DB proxy.

" - } - }, - "com.amazonaws.rds#ModifyDBProxyEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBProxyEndpointRequest" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBProxyEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Changes the settings for an existing DB proxy endpoint.

" - } - }, - "com.amazonaws.rds#ModifyDBProxyEndpointRequest": { - "type": "structure", - "members": { - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

", - "smithy.api#required": {} - } - }, - "NewDBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The new identifier for the DBProxyEndpoint. An identifier must\n begin with a letter and must contain only ASCII letters, digits, and hyphens; it\n can't end with a hyphen or contain two consecutive hyphens.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint\n uses a different VPC than the original proxy, you also specify a different\n set of security group IDs than for the original proxy.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBProxyEndpointResponse": { - "type": "structure", - "members": { - "DBProxyEndpoint": { - "target": "com.amazonaws.rds#DBProxyEndpoint", - "traits": { - "smithy.api#documentation": "

The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyDBProxyRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DBProxy to modify.

", - "smithy.api#required": {} - } - }, - "NewDBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" - } - }, - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigList", - "traits": { - "smithy.api#documentation": "

The new authentication settings for the DBProxy.

" - } - }, - "RequireTLS": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't\n use TLS.

" - } - }, - "IdleClientTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" - } - }, - "DebugLogging": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The new list of security groups for the DBProxy.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBProxyResponse": { - "type": "structure", - "members": { - "DBProxy": { - "target": "com.amazonaws.rds#DBProxy", - "traits": { - "smithy.api#documentation": "

The DBProxy object representing the new settings for the proxy.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyDBProxyTargetGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the properties of a DBProxyTargetGroup.

" - } - }, - "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest": { - "type": "structure", - "members": { - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the target group to modify.

", - "smithy.api#required": {} - } - }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the proxy.

", - "smithy.api#required": {} - } - }, - "ConnectionPoolConfig": { - "target": "com.amazonaws.rds#ConnectionPoolConfiguration", - "traits": { - "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" - } - }, - "NewName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse": { - "type": "structure", - "members": { - "DBProxyTargetGroup": { - "target": "com.amazonaws.rds#DBProxyTargetGroup", - "traits": { - "smithy.api#documentation": "

The settings of the modified DBProxyTarget.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

", - "smithy.api#examples": [ - { - "title": "To modify a DB snapshot", - "documentation": "The following example upgrades a PostgeSQL 10.6 snapshot named db5-snapshot-upg-test to PostgreSQL 11.7. The new DB engine version is shown after the snapshot has finished upgrading and its status is available.", - "input": { - "DBSnapshotIdentifier": "db5-snapshot-upg-test", - "EngineVersion": "11.7" - }, - "output": { - "DBSnapshot": { - "DBSnapshotIdentifier": "db5-snapshot-upg-test", - "DBInstanceIdentifier": "database-5", - "SnapshotCreateTime": "2020-03-27T20:49:17.092Z", - "Engine": "postgres", - "AllocatedStorage": 20, - "Status": "upgrading", - "Port": 5432, - "AvailabilityZone": "us-west-2a", - "VpcId": "vpc-2ff27557", - "InstanceCreateTime": "2020-03-27T19:59:04.735Z", - "MasterUsername": "postgres", - "EngineVersion": "10.6", - "LicenseModel": "postgresql-license", - "SnapshotType": "manual", - "OptionGroupName": "default:postgres-11", - "PercentProgress": 100, - "StorageType": "gp2", - "Encrypted": false, - "DBSnapshotArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test", - "IAMDatabaseAuthenticationEnabled": false, - "ProcessorFeatures": [], - "DbiResourceId": "db-GJMF75LM42IL6BTFRE4UZJ5YM4" - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBSnapshotAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.

", - "smithy.api#examples": [ - { - "title": "To allow two AWS accounts to restore a DB snapshot", - "documentation": "The following example grants permission to two AWS accounts, with the identifiers 111122223333 and 444455556666, to restore the DB snapshot named mydbsnapshot.", - "input": { - "DBSnapshotIdentifier": "mydbsnapshot", - "AttributeName": "restore", - "ValuesToAdd": [ - "111122223333", - "444455556666" - ] - }, - "output": { - "DBSnapshotAttributesResult": { - "DBSnapshotIdentifier": "mydbsnapshot", - "DBSnapshotAttributes": [ - { - "AttributeName": "restore", - "AttributeValues": [ - "111122223333", - "444455556666" - ] - } - ] - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot to modify the attributes for.

", - "smithy.api#required": {} - } - }, - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.

\n ", - "smithy.api#required": {} - } - }, - "ValuesToAdd": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" - } - }, - "ValuesToRemove": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBSnapshotAttributeResult": { - "type": "structure", - "members": { - "DBSnapshotAttributesResult": { - "target": "com.amazonaws.rds#DBSnapshotAttributesResult" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyDBSnapshotMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB snapshot to modify.

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n
    \n
  • \n

    \n 5.5.46 (supported for 5.1 DB snapshots)

    \n
    • \n
\n

\n Oracle\n

\n
    \n
  • \n

    \n 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB\n snapshots)

    \n
    • \n
  • \n

    \n 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB\n snapshots)

    \n
    • \n
  • \n

    \n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    \n
    • \n
\n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.

\n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBSnapshotResult": { - "type": "structure", - "members": { - "DBSnapshot": { - "target": "com.amazonaws.rds#DBSnapshot" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyDBSubnetGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBSubnetGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBSubnetGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#SubnetAlreadyInUse" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

", - "smithy.api#examples": [ - { - "title": "To modify a DB subnet group", - "documentation": "The following example adds a subnet with the ID subnet-08e41f9e230222222 to the DB subnet group named mysubnetgroup. To keep the existing subnets in the subnet group, include their IDs as values in the --subnet-ids option. Make sure to have subnets with at least two different Availability Zones in the DB subnet group.", - "input": { - "DBSubnetGroupName": "mysubnetgroup", - "DBSubnetGroupDescription": "", - "SubnetIds": [ - "subnet-0a1dc4e1a6f123456", - "subnet-070dd7ecb3aaaaaaa", - "subnet-00f5b198bc0abcdef", - "subnet-08e41f9e230222222" - ] - }, - "output": { - "DBSubnetGroup": { - "DBSubnetGroupName": "mysubnetgroup", - "DBSubnetGroupDescription": "test DB subnet group", - "VpcId": "vpc-0f08e7610a1b2c3d4", - "SubnetGroupStatus": "Complete", - "Subnets": [ - { - "SubnetIdentifier": "subnet-08e41f9e230222222", - "SubnetAvailabilityZone": { - "Name": "us-west-2a" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", - "SubnetAvailabilityZone": { - "Name": "us-west-2b" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-00f5b198bc0abcdef", - "SubnetAvailabilityZone": { - "Name": "us-west-2d" - }, - "SubnetStatus": "Active" - }, - { - "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", - "SubnetAvailabilityZone": { - "Name": "us-west-2b" - }, - "SubnetStatus": "Active" - } - ], - "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:mysubnetgroup" - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", - "smithy.api#required": {} - } - }, - "DBSubnetGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB subnet group.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.rds#SubnetIdentifierList", - "traits": { - "smithy.api#documentation": "

The EC2 subnet IDs for the DB subnet group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyDBSubnetGroupResult": { - "type": "structure", - "members": { - "DBSubnetGroup": { - "target": "com.amazonaws.rds#DBSubnetGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyEventSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyEventSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyEventSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#SNSInvalidTopicFault" - }, - { - "target": "com.amazonaws.rds#SNSNoAuthorizationFault" - }, - { - "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

\n

You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

", - "smithy.api#examples": [ - { - "title": "To modify an event subscription", - "documentation": "The following example turns off the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic.", - "input": { - "SubscriptionName": "my-instance-events", - "Enabled": false - }, - "output": { - "EventSubscription": { - "EventCategoriesList": [ - "backup", - "recovery" - ], - "CustomerAwsId": "123456789012", - "SourceType": "db-instance", - "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", - "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", - "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", - "CustSubscriptionId": "my-instance-events", - "Status": "modifying", - "Enabled": false - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyEventSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription.

", - "smithy.api#required": {} - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" - } - }, - "Enabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to activate the subscription.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyEventSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora global database clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To modify a global database cluster", - "documentation": "The following example enables deletion protection for an Aurora MySQL-based global database cluster.", - "input": { - "GlobalClusterIdentifier": "myglobalcluster", - "DeletionProtection": true - }, - "output": { - "GlobalCluster": { - "GlobalClusterIdentifier": "myglobalcluster", - "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", - "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", - "Status": "available", - "Engine": "aurora-mysql", - "EngineVersion": "5.7.mysql_aurora.2.07.2", - "StorageEncrypted": false, - "DeletionProtection": true, - "GlobalClusterMembers": [] - } - } - } - ] - } - }, - "com.amazonaws.rds#ModifyGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster.

    \n
    • \n
" - } - }, - "NewGlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new cluster identifier for the global database cluster.\n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster2\n

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable deletion protection for the global database cluster. The global database cluster\n can't be deleted when deletion protection is enabled.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n

\n

To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" - } - }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether to allow major version upgrades.

\n

Constraints: Must be enabled if you specify a value for the\n EngineVersion parameter that's a different major version than the global\n cluster's current version.

\n

If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#ModifyOptionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyOptionGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyOptionGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies an existing option group.

", - "smithy.api#examples": [ - { - "title": "To modify an option group", - "documentation": "The following example adds an option to an option group.", - "input": { - "OptionGroupName": "myawsuser-og02", - "OptionsToInclude": [ - { - "OptionName": "MEMCACHED", - "DBSecurityGroupMemberships": [ - "default" - ] - } - ], - "ApplyImmediately": true - }, - "output": { - "OptionGroup": {} - } - } - ] - } - }, - "com.amazonaws.rds#ModifyOptionGroupMessage": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to be modified.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

", - "smithy.api#required": {} - } - }, - "OptionsToInclude": { - "target": "com.amazonaws.rds#OptionConfigurationList", - "traits": { - "smithy.api#documentation": "

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

" - } - }, - "OptionsToRemove": { - "target": "com.amazonaws.rds#OptionNamesList", - "traits": { - "smithy.api#documentation": "

Options in this list are removed from the option group.

" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ModifyOptionGroupResult": { - "type": "structure", - "members": { - "OptionGroup": { - "target": "com.amazonaws.rds#OptionGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#NetworkTypeNotSupported": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "NetworkTypeNotSupported", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#Option": { - "type": "structure", - "members": { - "OptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option.

" - } - }, - "OptionDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option.

" - } - }, - "Persistent": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicate if this option is persistent.

" - } - }, - "Permanent": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicate if this option is permanent.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

If required, the port configured for this option to use.

" - } - }, - "OptionVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the option.

" - } - }, - "OptionSettings": { - "target": "com.amazonaws.rds#OptionSettingConfigurationList", - "traits": { - "smithy.api#documentation": "

The option settings for this option.

" - } - }, - "DBSecurityGroupMemberships": { - "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

If the option requires access to a port, then this DB security group allows access to the port.

" - } - }, - "VpcSecurityGroupMemberships": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

If the option requires access to a port, then this VPC security group allows access to the port.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Option details.

" - } - }, - "com.amazonaws.rds#OptionConfiguration": { - "type": "structure", - "members": { - "OptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The configuration of options to include in a group.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The optional port for the option.

" - } - }, - "OptionVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version for the option.

" - } - }, - "DBSecurityGroupMemberships": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DBSecurityGroupMembership name strings used for this option.

" - } - }, - "VpcSecurityGroupMemberships": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VpcSecurityGroupMembership name strings used for this option.

" - } - }, - "OptionSettings": { - "target": "com.amazonaws.rds#OptionSettingsList", - "traits": { - "smithy.api#documentation": "

The option settings to include in an option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of all available options

" - } - }, - "com.amazonaws.rds#OptionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionConfiguration", - "traits": { - "smithy.api#xmlName": "OptionConfiguration" - } - } - }, - "com.amazonaws.rds#OptionGroup": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the option group.

" - } - }, - "OptionGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides a description of the option group.

" - } - }, - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the name of the engine that this option group can be applied to.

" - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the major engine version associated with this option group.

" - } - }, - "Options": { - "target": "com.amazonaws.rds#OptionsList", - "traits": { - "smithy.api#documentation": "

Indicates what options are available in the option group.

" - } - }, - "AllowsVpcAndNonVpcInstanceMemberships": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.

" - } - }, - "OptionGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the option group.

" - } - }, - "SourceOptionGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the option group from which this option group is copied.

" - } - }, - "SourceAccountId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

" - } - }, - "CopyTimestamp": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Indicates when the option group was copied.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#OptionGroupAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OptionGroupAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The option group you are trying to create already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#OptionGroupMembership": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group that the instance belongs to.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are: \n in-sync, \n pending-apply, \n pending-removal, \n pending-maintenance-apply, \n pending-maintenance-removal, \n applying, \n removing, \n and failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information on the option groups the DB instance is a member of.

" - } - }, - "com.amazonaws.rds#OptionGroupMembershipList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionGroupMembership", - "traits": { - "smithy.api#xmlName": "OptionGroupMembership" - } - } - }, - "com.amazonaws.rds#OptionGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OptionGroupNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified option group could not be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#OptionGroupOption": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option.

" - } - }, - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the engine that this option can be applied to.

" - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the major engine version that the option is available for.

" - } - }, - "MinimumRequiredMinorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The minimum required engine version for the option to be applied.

" - } - }, - "PortRequired": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the option requires a port.

" - } - }, - "DefaultPort": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

If the option requires a port, specifies the default port for the option.

" - } - }, - "OptionsDependedOn": { - "target": "com.amazonaws.rds#OptionsDependedOn", - "traits": { - "smithy.api#documentation": "

The options that are prerequisites for this option.

" - } - }, - "OptionsConflictsWith": { - "target": "com.amazonaws.rds#OptionsConflictsWith", - "traits": { - "smithy.api#documentation": "

The options that conflict with this option.

" - } - }, - "Persistent": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

" - } - }, - "Permanent": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

" - } - }, - "RequiresAutoMinorEngineVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.

" - } - }, - "VpcOnly": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If true, you can only use this option with a DB instance that is in a VPC.

" - } - }, - "SupportsOptionVersionDowngrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.

" - } - }, - "OptionGroupOptionSettings": { - "target": "com.amazonaws.rds#OptionGroupOptionSettingsList", - "traits": { - "smithy.api#documentation": "

The option settings that are available (and the default value) for each option in an option group.

" - } - }, - "OptionGroupOptionVersions": { - "target": "com.amazonaws.rds#OptionGroupOptionVersionsList", - "traits": { - "smithy.api#documentation": "

The versions that are available for the option.

" - } - }, - "CopyableCrossAccount": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the option can be copied across Amazon Web Services accounts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Available option.

" - } - }, - "com.amazonaws.rds#OptionGroupOptionSetting": { - "type": "structure", - "members": { - "SettingName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group option.

" - } - }, - "SettingDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option group option.

" - } - }, - "DefaultValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The default value for the option group option.

" - } - }, - "ApplyType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine specific parameter type for the option group option.

" - } - }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the acceptable values for the option group option.

" - } - }, - "IsModifiable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value where true indicates that this option group option can be changed from the default value.

" - } - }, - "IsRequired": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

" - } - }, - "MinimumEngineVersionPerAllowedValue": { - "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList", - "traits": { - "smithy.api#documentation": "

The minimum DB engine version required for the corresponding allowed value for this option setting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" - } - }, - "com.amazonaws.rds#OptionGroupOptionSettingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionGroupOptionSetting", - "traits": { - "smithy.api#xmlName": "OptionGroupOptionSetting" - } - } - }, - "com.amazonaws.rds#OptionGroupOptionVersionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionVersion", - "traits": { - "smithy.api#xmlName": "OptionVersion" - } - } - }, - "com.amazonaws.rds#OptionGroupOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionGroupOption", - "traits": { - "smithy.api#xmlName": "OptionGroupOption" - } - }, - "traits": { - "smithy.api#documentation": "

List of available option group options.

" - } - }, - "com.amazonaws.rds#OptionGroupOptionsMessage": { - "type": "structure", - "members": { - "OptionGroupOptions": { - "target": "com.amazonaws.rds#OptionGroupOptionsList" - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#OptionGroupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OptionGroupQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The quota of 20 option groups was exceeded for this Amazon Web Services account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#OptionGroups": { - "type": "structure", - "members": { - "OptionGroupsList": { - "target": "com.amazonaws.rds#OptionGroupsList", - "traits": { - "smithy.api#documentation": "

List of option groups.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

List of option groups.

" - } - }, - "com.amazonaws.rds#OptionGroupsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionGroup", - "traits": { - "smithy.api#xmlName": "OptionGroup" - } - } - }, - "com.amazonaws.rds#OptionNamesList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#OptionSetting": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option that has settings that you can set.

" - } - }, - "Value": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The current value of the option setting.

" - } - }, - "DefaultValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The default value of the option setting.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option setting.

" - } - }, - "ApplyType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine specific parameter type.

" - } - }, - "DataType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The data type of the option setting.

" - } - }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The allowed values of the option setting.

" - } - }, - "IsModifiable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that, when true, indicates the option setting can be modified from the default.

" - } - }, - "IsCollection": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the option setting is part of a collection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" - } - }, - "com.amazonaws.rds#OptionSettingConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionSetting", - "traits": { - "smithy.api#xmlName": "OptionSetting" - } - } - }, - "com.amazonaws.rds#OptionSettingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionSetting", - "traits": { - "smithy.api#xmlName": "OptionSetting" - } - } - }, - "com.amazonaws.rds#OptionVersion": { - "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the option.

" - } - }, - "IsDefault": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if the version is the default version of the option, and otherwise false.

" - } - } + } + ] + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The RDS Amazon Resource Name (ARN) of the resource that the \n pending maintenance action applies to. For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "ApplyAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

", + "smithy.api#required": {} + } + }, + "OptInType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid values:

\n
    \n
  • \n

    \n immediate - Apply the maintenance action immediately.

    \n
    • \n
  • \n

    \n next-maintenance - Apply the maintenance action during\n the next maintenance window for the resource.

    \n
    • \n
  • \n

    \n undo-opt-in - Cancel any existing next-maintenance\n opt-in requests.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceActionResult": { + "type": "structure", + "members": { + "ResourcePendingMaintenanceActions": { + "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#AttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "AttributeValue" + } + } + }, + "com.amazonaws.rds#AuditPolicyState": { + "type": "enum", + "members": { + "LOCKED_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locked" + } + }, + "UNLOCKED_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocked" + } + } + } + }, + "com.amazonaws.rds#AuthScheme": { + "type": "enum", + "members": { + "SECRETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRETS" + } + } + } + }, + "com.amazonaws.rds#AuthorizationAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group is already authorized for\n the specified DB security group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#AuthorizationNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.

\n

Or, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#AuthorizationQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB security group authorization quota has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage" + }, + "output": { + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#AuthorizationQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To authorize DB security group integress", + "documentation": "This example authorizes access to the specified security group by the specified CIDR block.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "CIDRIP": "203.0.113.5/32" }, - "traits": { - "smithy.api#documentation": "

The version for an option. Option group option versions are returned by \n the DescribeOptionGroupOptions action.

" - } - }, - "com.amazonaws.rds#OptionsConflictsWith": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "OptionConflictName" - } - } - }, - "com.amazonaws.rds#OptionsDependedOn": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "OptionName" - } - } - }, - "com.amazonaws.rds#OptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Option", - "traits": { - "smithy.api#xmlName": "Option" - } + "output": { + "DBSecurityGroup": {} } - }, - "com.amazonaws.rds#OrderableDBInstanceOption": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine type of a DB instance.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version of a DB instance.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class for a DB instance.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model for a DB instance.

" - } - }, - "AvailabilityZoneGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone group for a DB instance.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones for a DB instance.

" - } - }, - "MultiAZCapable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance is Multi-AZ capable.

" - } - }, - "ReadReplicaCapable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance can have a read replica.

" - } - }, - "Vpc": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance is in a VPC.

" - } - }, - "SupportsStorageEncryption": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports encrypted storage.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the storage type for a DB instance.

" - } - }, - "SupportsIops": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports provisioned IOPS.

" - } - }, - "SupportsEnhancedMonitoring": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

" - } - }, - "SupportsIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports IAM database authentication.

" - } - }, - "SupportsPerformanceInsights": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if a DB instance supports Performance Insights, otherwise false.

" - } - }, - "MinStorageSize": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Minimum storage size for a DB instance.

" - } - }, - "MaxStorageSize": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Maximum storage size for a DB instance.

" - } - }, - "MinIopsPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Minimum total provisioned IOPS for a DB instance.

" - } - }, - "MaxIopsPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Maximum total provisioned IOPS for a DB instance.

" - } - }, - "MinIopsPerGib": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Minimum provisioned IOPS per GiB for a DB instance.

" - } - }, - "MaxIopsPerGib": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Maximum provisioned IOPS per GiB for a DB instance.

" - } - }, - "AvailableProcessorFeatures": { - "target": "com.amazonaws.rds#AvailableProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

A list of the available processor features for the DB instance class of a DB instance.

" - } - }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", - "traits": { - "smithy.api#documentation": "

A list of the supported DB engine modes.

" - } - }, - "SupportsStorageAutoscaling": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

" - } - }, - "SupportsKerberosAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether a DB instance supports Kerberos Authentication.

" - } - }, - "OutpostCapable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" - } - }, - "SupportedActivityStreamModes": { - "target": "com.amazonaws.rds#ActivityStreamModeList", - "traits": { - "smithy.api#documentation": "

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync,\n async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams \n isn't supported, the return value is an empty list.

" - } - }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

" - } - }, - "SupportsClusters": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether DB instances can be configured as a Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "SupportedNetworkTypes": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "SupportsStorageThroughput": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports storage throughput.

" - } - }, - "MinStorageThroughputPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Minimum storage throughput for a DB instance.

" - } - }, - "MaxStorageThroughputPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Maximum storage throughput for a DB instance.

" - } - }, - "MinStorageThroughputPerIops": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

" - } - }, - "MaxStorageThroughputPerIops": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

" - } - } + } + ] + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to add authorization to.

", + "smithy.api#required": {} + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The IP range to authorize.

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName \n or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#AutomationMode": { + "type": "enum", + "members": { + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "full" + } + }, + "ALL_PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all-paused" + } + } + } + }, + "com.amazonaws.rds#AvailabilityZone": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains Availability Zone information.

\n

This data type is used as an element in the OrderableDBInstanceOption\n data type.

" + } + }, + "com.amazonaws.rds#AvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AvailabilityZone", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.rds#AvailabilityZones": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.rds#AvailableProcessorFeature": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount \n and threadsPerCore.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value for the processor feature of the DB instance class.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed values for the processor feature of the DB instance class.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the available processor feature information for the DB instance class of a DB instance.

\n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" + } + }, + "com.amazonaws.rds#AvailableProcessorFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AvailableProcessorFeature", + "traits": { + "smithy.api#xmlName": "AvailableProcessorFeature" + } + } + }, + "com.amazonaws.rds#AwsBackupRecoveryPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 43, + "max": 350 + }, + "smithy.api#pattern": "^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$" + } + }, + "com.amazonaws.rds#BacktrackDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#BacktrackDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterBacktrack" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.

\n \n

This action applies only to Aurora MySQL DB clusters.

\n " + } + }, + "com.amazonaws.rds#BacktrackDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "BacktrackTo": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n

\n \n

If the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.

\n \n

Constraints:

\n
    \n
  • \n

    Must contain a valid ISO 8601 timestamp.

    \n
    • \n
  • \n

    Can't contain a timestamp set in the future.

    \n
    • \n
\n

Example: 2017-07-08T18:00Z\n

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

" + } + }, + "UseEarliestTimeOnPointInTimeUnavailable": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#BackupPolicyNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BackupPolicyNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#deprecated": { + "message": "Please avoid using this fault" + }, + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#BlueGreenDeployment": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the blue/green deployment.

" + } + }, + "BlueGreenDeploymentName": { + "target": "com.amazonaws.rds#BlueGreenDeploymentName", + "traits": { + "smithy.api#documentation": "

The user-supplied name of the blue/green deployment.

" + } + }, + "Source": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The source database for the blue/green deployment.

\n

Before switchover, the source database is the production database in the blue environment.

" + } + }, + "Target": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The target database for the blue/green deployment.

\n

Before switchover, the target database is the clone database in the green environment.

" + } + }, + "SwitchoverDetails": { + "target": "com.amazonaws.rds#SwitchoverDetailList", + "traits": { + "smithy.api#documentation": "

The details about each source and target resource in the blue/green deployment.

" + } + }, + "Tasks": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskList", + "traits": { + "smithy.api#documentation": "

Either tasks to be performed or tasks that have been completed on the target database before switchover.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#BlueGreenDeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the blue/green deployment.

\n

Valid Values:

\n
    \n
  • \n

    \n PROVISIONING - Resources are being created in the green environment.

    \n
    • \n
  • \n

    \n AVAILABLE - Resources are available in the green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_IN_PROGRESS - The deployment is being switched from the blue environment to the \n green environment.

    \n
    • \n
  • \n

    \n SWITCHOVER_COMPLETED - Switchover from the blue environment to the green environment is complete.

    \n
    • \n
  • \n

    \n INVALID_CONFIGURATION - Resources in the green environment are invalid, so switchover isn't possible.

    \n
    • \n
  • \n

    \n SWITCHOVER_FAILED - Switchover was attempted but failed.

    \n
    • \n
  • \n

    \n DELETING - The blue/green deployment is being deleted.

    \n
    • \n
" + } + }, + "StatusDetails": { + "target": "com.amazonaws.rds#BlueGreenDeploymentStatusDetails", + "traits": { + "smithy.api#documentation": "

Additional information about the status of the blue/green deployment.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the blue/green deployment was created, in Universal Coordinated Time\n (UTC).

" + } + }, + "DeleteTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the blue/green deployment was deleted, in Universal Coordinated Time\n (UTC).

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

Details about a blue/green deployment.

\n

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

" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BlueGreenDeploymentAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A blue/green deployment with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#BlueGreenDeploymentIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BlueGreenDeploymentNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#BlueGreenDeploymentStatus": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentStatusDetails": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentTask": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskName", + "traits": { + "smithy.api#documentation": "

The name of the blue/green deployment task.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the blue/green deployment task.

\n

Valid Values:

\n
    \n
  • \n

    \n PENDING - The resource is being prepared for deployment.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The resource is being deployed.

    \n
    • \n
  • \n

    \n COMPLETED - The resource has been deployed.

    \n
    • \n
  • \n

    \n FAILED - Deployment of the resource failed.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a task for a blue/green deployment.

\n

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

" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTask" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskName": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskStatus": { + "type": "string" + }, + "com.amazonaws.rds#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.rds#BooleanOptional": { + "type": "boolean" + }, + "com.amazonaws.rds#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#CACertificateIdentifiersList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CancelExportTaskMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTask" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ExportTaskNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportTaskStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.

", + "smithy.api#examples": [ + { + "title": "To cancel a snapshot export to Amazon S3", + "documentation": "The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.", + "input": { + "ExportTaskIdentifier": "my-s3-export-1" }, - "traits": { - "smithy.api#documentation": "

Contains a list of available options for a DB instance.

\n

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" - } - }, - "com.amazonaws.rds#OrderableDBInstanceOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OrderableDBInstanceOption", - "traits": { - "smithy.api#xmlName": "OrderableDBInstanceOption" - } - } - }, - "com.amazonaws.rds#OrderableDBInstanceOptionsMessage": { - "type": "structure", - "members": { - "OrderableDBInstanceOptions": { - "target": "com.amazonaws.rds#OrderableDBInstanceOptionsList", - "traits": { - "smithy.api#documentation": "

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } + "output": { + "ExportTaskIdentifier": "my-s3-export-1", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot", + "SnapshotTime": "2019-03-24T20:01:09.815Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff", + "Status": "CANCELING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + } + ] + } + }, + "com.amazonaws.rds#CancelExportTaskMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the snapshot or cluster export task to cancel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#Certificate": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique key that identifies a certificate.

" + } + }, + "CertificateType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the certificate.

" + } + }, + "Thumbprint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The thumbprint of the certificate.

" + } + }, + "ValidFrom": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The starting date from which the certificate is valid.

" + } + }, + "ValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The final date that the certificate continues to be valid.

" + } + }, + "CertificateArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" + } + }, + "CustomerOverride": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether there is an override for the default certificate identifier.

" + } + }, + "CustomerOverrideValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

If there is an override for the default certificate identifier, when the override\n expires.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CA certificate for an Amazon Web Services account.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#CertificateDetails": { + "type": "structure", + "members": { + "CAIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA identifier of the CA certificate used for the DB instance's server certificate.

" + } + }, + "ValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The expiration date of the DB instance’s server certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the details of the DB instance’s server certificate.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#CertificateList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Certificate", + "traits": { + "smithy.api#xmlName": "Certificate" + } + } + }, + "com.amazonaws.rds#CertificateMessage": { + "type": "structure", + "members": { + "Certificates": { + "target": "com.amazonaws.rds#CertificateList", + "traits": { + "smithy.api#documentation": "

The list of Certificate objects for the Amazon Web Services account.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeCertificates action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CertificateNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CertificateNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an\n existing certificate.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CharacterSet": { + "type": "structure", + "members": { + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the character set.

" + } + }, + "CharacterSetDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the character set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" + } + }, + "com.amazonaws.rds#ClientPasswordAuthType": { + "type": "enum", + "members": { + "MYSQL_NATIVE_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL_NATIVE_PASSWORD" + } + }, + "POSTGRES_SCRAM_SHA_256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRES_SCRAM_SHA_256" + } + }, + "POSTGRES_MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRES_MD5" + } + }, + "SQL_SERVER_AUTHENTICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SERVER_AUTHENTICATION" + } + } + } + }, + "com.amazonaws.rds#CloudwatchLogsExportConfiguration": { + "type": "structure", + "members": { + "EnableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types to enable.

" + } + }, + "DisableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types to disable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.

\n

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ClusterPendingModifiedValues": { + "type": "structure", + "members": { + "PendingCloudwatchLogsExports": { + "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DBClusterIdentifier value for the DB cluster.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master credentials for the DB cluster.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, \n AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but \n instead automatically adjusts as needed.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type for the DB cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBCluster operation and \n contains changes that will be applied during the next maintenance window.

" + } + }, + "com.amazonaws.rds#ConnectionPoolConfiguration": { + "type": "structure", + "members": { + "MaxConnectionsPercent": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints: Must be between 1 and 100.

" + } + }, + "MaxIdleConnectionsPercent": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

\n

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

" + } + }, + "ConnectionBorrowTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

\n

Default: 120

\n

Constraints: between 1 and 3600, or 0 representing unlimited

" + } + }, + "SessionPinningFilters": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

\n

Default: no session pinning filters

" + } + }, + "InitQuery": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

\n

Default: no initialization query

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#ConnectionPoolConfigurationInfo": { + "type": "structure", + "members": { + "MaxConnectionsPercent": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

" + } + }, + "MaxIdleConnectionsPercent": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

" + } + }, + "ConnectionBorrowTimeout": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

" + } + }, + "SessionPinningFilters": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. \n Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

" + } + }, + "InitQuery": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

" + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB cluster parameter group.

", + "smithy.api#examples": [ + { + "title": "To copy a DB cluster parameter group", + "documentation": "This example copies a DB cluster parameter group.", + "input": { + "SourceDBClusterParameterGroupIdentifier": "mydbclusterparametergroup", + "TargetDBClusterParameterGroupIdentifier": "mydbclusterparametergroup-copy", + "TargetDBClusterParameterGroupDescription": "My DB cluster parameter group copy" }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#Outpost": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" - } - } + "output": { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup-copy", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group copy" + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "SourceDBClusterParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid DB cluster parameter group.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDBClusterParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copied DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-cluster-param-group1\n

", + "smithy.api#required": {} + } + }, + "TargetDBClusterParameterGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description for the copied DB cluster parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroupResult": { + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#DBClusterParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:

\n
    \n
  • \n

    \n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot\n identifier for the encrypted DB cluster snapshot to be copied. This identifier\n must be in the ARN format for the source Amazon Web Services Region and is the same value as\n the SourceDBClusterSnapshotIdentifier in the presigned URL.

    \n
    • \n
\n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To copy a DB cluster snapshot", + "documentation": "The following example creates a copy of a DB cluster snapshot, including its tags.", + "input": { + "SourceDBClusterSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16", + "TargetDBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "CopyTags": true }, - "traits": { - "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#Parameter": { - "type": "structure", - "members": { - "ParameterName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the parameter.

" - } - }, - "ParameterValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the value of the parameter.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides a description of the parameter.

" - } - }, - "Source": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the source of the parameter value.

" - } - }, - "ApplyType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the engine specific parameters type.

" - } - }, - "DataType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" - } - }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" - } - }, - "IsModifiable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.

" - } - }, - "MinimumEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" - } - }, - "ApplyMethod": { - "target": "com.amazonaws.rds#ApplyMethod", - "traits": { - "smithy.api#documentation": "

Indicates when to apply parameter updates.

" - } - }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", - "traits": { - "smithy.api#documentation": "

The valid DB engine modes.

" - } - } + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": ["us-east-1a", "us-east-1b", "us-east-1e"], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "myaurora", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-123example", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "SourceDBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
  • \n

    If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

    \n
    • \n
  • \n

    If the source snapshot is in a different Amazon Web Services Region than the copy,\n specify a valid DB cluster snapshot ARN. For more information, go to\n \n Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

    \n
    • \n
\n

Example: my-cluster-snapshot1\n

", + "smithy.api#required": {} + } + }, + "TargetDBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster-snapshot2\n

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

\n

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

\n

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

\n

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.

\n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key\n to use to encrypt the copy of the DB cluster snapshot in the destination\n Amazon Web Services Region. This is the same identifier for both the\n CopyDBClusterSnapshot operation that is called in the\n destination Amazon Web Services Region, and the operation contained in the presigned\n URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region \n that the DB cluster snapshot is to be created in.

    \n
    • \n
  • \n

    \n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + }, + "CopyTags": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CopyDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB parameter group.

", + "smithy.api#examples": [ + { + "title": "To copy a DB parameter group", + "documentation": "The following example makes a copy of a DB parameter group.", + "input": { + "SourceDBParameterGroupIdentifier": "mydbpg", + "TargetDBParameterGroupIdentifier": "mydbpgcopy", + "TargetDBParameterGroupDescription": "Copy of mydbpg parameter group" }, - "traits": { - "smithy.api#documentation": "

This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

" - } - }, - "com.amazonaws.rds#ParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Parameter", - "traits": { - "smithy.api#xmlName": "Parameter" - } - } - }, - "com.amazonaws.rds#PendingCloudwatchLogsExports": { - "type": "structure", - "members": { - "LogTypesToEnable": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

" - } - }, - "LogTypesToDisable": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

" - } - } + "output": { + "DBParameterGroup": { + "DBParameterGroupName": "mydbpgcopy", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", + "DBParameterGroupFamily": "mysql5.7", + "Description": "Copy of mydbpg parameter group" + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyDBParameterGroupMessage": { + "type": "structure", + "members": { + "SourceDBParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid DB parameter group.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDBParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-db-parameter-group\n

", + "smithy.api#required": {} + } + }, + "TargetDBParameterGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description for the copied DB parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyDBParameterGroupResult": { + "type": "structure", + "members": { + "DBParameterGroup": { + "target": "com.amazonaws.rds#DBParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CopyDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.

\n

This command doesn't apply to RDS Custom.

\n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

", + "smithy.api#examples": [ + { + "title": "To copy a DB snapshot", + "documentation": "The following example creates a copy of a DB snapshot.", + "input": { + "SourceDBSnapshotIdentifier": "rds:database-mysql-2019-06-06-08-38", + "TargetDBSnapshotIdentifier": "mydbsnapshotcopy" }, - "traits": { - "smithy.api#documentation": "

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

" - } - }, - "com.amazonaws.rds#PendingMaintenanceAction": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource. \n Valid actions are system-update, db-upgrade, hardware-maintenance, \n and ca-certificate-rotation.

" - } - }, - "AutoAppliedAfterDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date of the maintenance window when the action is applied.\n The maintenance action is applied to the resource during\n its first maintenance window after this date.

" - } - }, - "ForcedApplyDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date when the maintenance action is automatically applied.

\n

On this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.

" - } - }, - "OptInStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the type of opt-in request that has been received for the resource.

" - } - }, - "CurrentApplyDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The effective date when the pending maintenance action is applied \n to the resource. This date takes into account opt-in requests received from\n the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate,\n and the ForcedApplyDate. This value is blank if an \n opt-in request has not been received and nothing has been specified as\n AutoAppliedAfterDate or ForcedApplyDate.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" - } - } + "output": { + "DBSnapshot": { + "VpcId": "vpc-6594f31c", + "Status": "creating", + "Encrypted": true, + "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", + "MasterUsername": "admin", + "Iops": 1000, + "Port": 3306, + "LicenseModel": "general-public-license", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", + "EngineVersion": "5.6.40", + "OptionGroupName": "default:mysql-5-6", + "ProcessorFeatures": [], + "Engine": "mysql", + "StorageType": "io1", + "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "SnapshotType": "manual", + "IAMDatabaseAuthenticationEnabled": false, + "SourceRegion": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "AvailabilityZone": "us-east-1f", + "PercentProgress": 0, + "AllocatedStorage": 100, + "DBSnapshotIdentifier": "mydbsnapshotcopy" + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyDBSnapshotMessage": { + "type": "structure", + "members": { + "SourceDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid system snapshot in the \"available\" state.

    \n
    • \n
\n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", + "smithy.api#required": {} + } + }, + "TargetDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copy of the snapshot.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-db-snapshot\n

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

\n

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.

\n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.

\n

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "CopyTags": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted DB\n snapshot is copied to. This Amazon Web Services Region is the same one where the\n CopyDBSnapshot operation is called that contains this presigned\n URL.

    \n

    For example, if you copy an encrypted DB snapshot from the us-west-2\n Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the\n CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and\n provide a presigned URL that contains a call to the CopyDBSnapshot\n operation in the us-west-2 Amazon Web Services Region. For this example, the\n DestinationRegion in the presigned URL must be set to the\n us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the\n same identifier for both the CopyDBSnapshot operation that is\n called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.

    \n
    • \n
  • \n

    \n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.

" + } + }, + "TargetCustomAvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The external custom Availability Zone (CAZ) identifier for the target CAZ.

\n

Example: rds-caz-aiqhTgQv.

" + } + }, + "CopyOptionGroup": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CopyOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified option group.

", + "smithy.api#examples": [ + { + "title": "To copy an option group", + "documentation": "The following example makes a copy of an option group.", + "input": { + "SourceOptionGroupIdentifier": "myoptiongroup", + "TargetOptionGroupIdentifier": "new-option-group", + "TargetOptionGroupDescription": "My option group copy" }, - "traits": { - "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

" - } + "output": { + "OptionGroup": { + "Options": [], + "OptionGroupName": "new-option-group", + "MajorEngineVersion": "11.2", + "OptionGroupDescription": "My option group copy", + "AllowsVpcAndNonVpcInstanceMemberships": true, + "EngineName": "oracle-ee", + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" + } + } + } + ] + } + }, + "com.amazonaws.rds#CopyOptionGroupMessage": { + "type": "structure", + "members": { + "SourceOptionGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source option group.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid option group.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetOptionGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copied option group.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-option-group\n

", + "smithy.api#required": {} + } + }, + "TargetOptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the copied option group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CopyOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault" }, - "com.amazonaws.rds#PendingMaintenanceActionDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#PendingMaintenanceAction", - "traits": { - "smithy.api#xmlName": "PendingMaintenanceAction" - } - } + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, - "com.amazonaws.rds#PendingMaintenanceActions": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions", - "traits": { - "smithy.api#xmlName": "ResourcePendingMaintenanceActions" - } - } + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" }, - "com.amazonaws.rds#PendingMaintenanceActionsMessage": { - "type": "structure", - "members": { - "PendingMaintenanceActions": { - "target": "com.amazonaws.rds#PendingMaintenanceActions", - "traits": { - "smithy.api#documentation": "

A list of the pending maintenance actions for the resource.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned from the DescribePendingMaintenanceActions action.

", - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" }, - "com.amazonaws.rds#PendingModifiedValues": { - "type": "structure", - "members": { - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity class for the DB instance.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The allocated storage size for the DB instance specified in gibibytes (GiB).

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The master credentials for the DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port for the DB instance.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine version.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model for the DB instance.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The Provisioned IOPS value for the DB instance.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database identifier for the DB instance.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type of the DB instance.

" - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the CA certificate for the DB instance.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB subnet group for the DB instance.

" - } - }, - "PendingCloudwatchLogsExports": { - "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" - } - }, - "AutomationMode": { - "target": "com.amazonaws.rds#AutomationMode", - "traits": { - "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all-paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all-paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" - } - }, - "ResumeFullAutomationModeTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The storage throughput of the DB instance.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine of the DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBInstance operation and \n contains changes that will be applied during the next maintenance window.

" - } + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, - "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "PointInTimeRestoreNotEnabled", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, - "com.amazonaws.rds#ProcessorFeature": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount and threadsPerCore.

" - } - }, - "Value": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The value of a processor feature name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the processor features of a DB instance class.

\n

To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

\n

You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromS3\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \n
\n

You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

\n

In addition, you can use the following actions for DB instance class processor information:

\n
    \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribeDBSnapshots\n

    \n
    • \n
  • \n

    \n DescribeValidDBInstanceModifications\n

    \n
    • \n
\n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n
    \n
  • \n

    You are accessing an Oracle DB instance.

    \n
    • \n
  • \n

    Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

    \n
    • \n
  • \n

    The current number CPU cores and threads is set to a non-default value.

    \n
    • \n
\n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" - } + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, - "com.amazonaws.rds#ProcessorFeatureList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ProcessorFeature", - "traits": { - "smithy.api#xmlName": "ProcessorFeature" - } - } + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, - "com.amazonaws.rds#PromoteReadReplica": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#PromoteReadReplicaMessage" - }, - "output": { - "target": "com.amazonaws.rds#PromoteReadReplicaResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Promotes a read replica DB instance to a standalone DB instance.

\n \n
    \n
  • \n

    Backup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.

    \n
    • \n
  • \n

    This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

    \n
    • \n
\n ", - "smithy.api#examples": [ - { - "title": "To promote a read replica", - "documentation": "The following example promotes the specified read replica to become a standalone DB instance.", - "input": { - "DBInstanceIdentifier": "test-instance-repl" - }, - "output": { - "DBInstance": { - "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", - "StorageType": "standard", - "ReadReplicaSourceDBInstanceIdentifier": "test-instance", - "DBInstanceStatus": "modifying" - } - } - } - ] - } + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, - "com.amazonaws.rds#PromoteReadReplicaDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Promotes a read replica DB cluster to a standalone DB cluster.

" - } + { + "target": "com.amazonaws.rds#SourceClusterNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#SourceDatabaseNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a blue/green deployment.

\n

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

\n

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

\n

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

" + } + }, + "com.amazonaws.rds#CreateBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentName": { + "target": "com.amazonaws.rds#BlueGreenDeploymentName", + "traits": { + "smithy.api#documentation": "

The name of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

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

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

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

\n

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

", + "smithy.api#required": {} + } + }, + "TargetEngineVersion": { + "target": "com.amazonaws.rds#TargetEngineVersion", + "traits": { + "smithy.api#documentation": "

The engine version of the database in the green environment.

\n

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

" + } + }, + "TargetDBParameterGroupName": { + "target": "com.amazonaws.rds#TargetDBParameterGroupName", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "TargetDBClusterParameterGroupName": { + "target": "com.amazonaws.rds#TargetDBClusterParameterGroupName", + "traits": { + "smithy.api#documentation": "

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

\n

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

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the blue/green deployment.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersionFault" + }, + { + "target": "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom DB engine version (CEV).

" + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersionFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CreateCustomDBEngineVersionFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An error occurred while trying to create the CEV.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "

The database engine to use for your custom engine version (CEV). The only supported value is \n custom-oracle-ee.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#documentation": "

The name of your CEV. The name format is 19.customized_string.\n For example, a valid CEV name is 19.my_cev1. This setting is required for RDS\n Custom for Oracle, but optional for Amazon RDS. The combination of Engine\n and EngineVersion is unique per customer per Region.

", + "smithy.api#required": {} + } + }, + "DatabaseInstallationFilesS3BucketName": { + "target": "com.amazonaws.rds#BucketName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid \n bucket name is my-custom-installation-files.

" + } + }, + "DatabaseInstallationFilesS3Prefix": { + "target": "com.amazonaws.rds#String255", + "traits": { + "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid \n bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

" + } + }, + "ImageId": { + "target": "com.amazonaws.rds#String255", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required \n to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, \n but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs \n used by your CEVs by calling the DescribeDBEngineVersions operation.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#KmsKeyIdOrArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.

\n

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.

\n

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#Description", + "traits": { + "smithy.api#documentation": "

An optional description of your CEV.

" + } + }, + "Manifest": { + "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", + "traits": { + "smithy.api#documentation": "

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.

\n

The following JSON fields are valid:

\n
\n
MediaImportTemplateVersion
\n
\n

Version of the CEV manifest. The date is in the format YYYY-MM-DD.

\n
\n
databaseInstallationFileNames
\n
\n

Ordered list of installation files for the CEV.

\n
\n
opatchFileNames
\n
\n

Ordered list of OPatch installers used for the Oracle DB engine.

\n
\n
psuRuPatchFileNames
\n
\n

The PSU and RU patches for this CEV.

\n
\n
OtherPatchFileNames
\n
\n

The patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.

\n
\n
\n

For more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, - "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster read replica.

    \n
    • \n
\n

Example: my-cluster-replica1\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" }, - "com.amazonaws.rds#PromoteReadReplicaDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" }, - "com.amazonaws.rds#PromoteReadReplicaMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing read replica DB instance.

    \n
    • \n
\n

Example: mydbinstance\n

", - "smithy.api#required": {} - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas.

    \n
    • \n
" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, - "com.amazonaws.rds#PromoteReadReplicaResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, - "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ProvisionedIopsNotAvailableInAZFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Provisioned IOPS not available in the specified Availability Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, - "com.amazonaws.rds#PurchaseReservedDBInstancesOffering": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage" - }, - "output": { - "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Purchases a reserved DB instance offering.

", - "smithy.api#examples": [ - { - "title": "To purchase a reserved DB instance", - "documentation": "The following example shows how to buy the reserved DB instance offering from the previous example.", - "input": { - "ReservedDBInstancesOfferingId": "", - "ReservedDBInstanceId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4" - }, - "output": { - "ReservedDBInstance": { - "ReservedDBInstanceId": "ri-2020-06-29-16-54-57-670", - "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", - "DBInstanceClass": "db.t2.micro", - "StartTime": "2020-06-29T16:54:57.670Z", - "Duration": 31536000, - "FixedPrice": 51, - "UsagePrice": 0, - "CurrencyCode": "USD", - "DBInstanceCount": 1, - "ProductDescription": "mysql", - "OfferingType": "Partial Upfront", - "MultiAZ": false, - "State": "payment-pending", - "RecurringCharges": [ - { - "RecurringChargeAmount": 0.006, - "RecurringChargeFrequency": "Hourly" - } - ], - "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670" - } - } - } - ] - } + { + "target": "com.amazonaws.rds#DomainNotFoundFault" }, - "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { - "type": "structure", - "members": { - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the Reserved DB instance offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", - "smithy.api#required": {} - } - }, - "ReservedDBInstanceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Customer-specified identifier to track this reservation.

\n

Example: myreservationID

" - } - }, - "DBInstanceCount": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of instances to reserve.

\n

Default: 1\n

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" }, - "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult": { - "type": "structure", - "members": { - "ReservedDBInstance": { - "target": "com.amazonaws.rds#ReservedDBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" }, - "com.amazonaws.rds#Range": { - "type": "structure", - "members": { - "From": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum value in the range.

" - } - }, - "To": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum value in the range.

" - } - }, - "Step": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A range of integer values.

" - } + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, - "com.amazonaws.rds#RangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Range", - "traits": { - "smithy.api#xmlName": "Range" - } - } + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, - "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "ReadReplicaDBClusterIdentifier" - } - } + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" }, - "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "ReadReplicaDBInstanceIdentifier" - } - } + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" }, - "com.amazonaws.rds#ReadReplicaIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "ReadReplicaIdentifier" - } - } + { + "target": "com.amazonaws.rds#InvalidSubnet" }, - "com.amazonaws.rds#ReadersArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, - "com.amazonaws.rds#RebootDBCluster": { - "type": "operation", + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

If you create an Aurora DB cluster, the request creates an empty cluster. You must\n explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the\n request creates a writer and two reader DB instances for you, each in a different\n Availability Zone.

\n

You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or\n PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User\n Guide.

\n

You can also use the ReplicationSourceIdentifier parameter to create a\n Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the\n source. For more information about Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To create a MySQL 5.7-compatible DB cluster", + "documentation": "The following example creates a MySQL 5.7-compatible Aurora DB cluster.", "input": { - "target": "com.amazonaws.rds#RebootDBClusterMessage" + "DBClusterIdentifier": "sample-cluster", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.12", + "MasterUsername": "admin", + "MasterUserPassword": "mypassword", + "DBSubnetGroupName": "default", + "VpcSecurityGroupIds": ["sg-0b91305example"] }, "output": { - "target": "com.amazonaws.rds#RebootDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.

\n

Rebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

\n

Use this operation only for a non-Aurora Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

" - } - }, - "com.amazonaws.rds#RebootDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#RebootDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } + "DBCluster": { + "DBSubnetGroup": "default", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b91305example", + "Status": "active" + } + ], + "AllocatedStorage": 1, + "AssociatedRoles": [], + "PreferredBackupWindow": "09:12-09:42", + "ClusterCreateTime": "2019-06-07T23:21:33.048Z", + "DeletionProtection": false, + "IAMDatabaseAuthenticationEnabled": false, + "ReadReplicaIdentifiers": [], + "EngineMode": "provisioned", + "Engine": "aurora-mysql", + "StorageEncrypted": false, + "MultiAZ": false, + "PreferredMaintenanceWindow": "mon:04:31-mon:05:01", + "HttpEndpointEnabled": false, + "BackupRetentionPeriod": 1, + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": ["us-east-1a", "us-east-1b", "us-east-1e"], + "MasterUsername": "master", + "EngineVersion": "5.7.12", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster", + "DBClusterMembers": [], + "Port": 3306, + "Status": "creating", + "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "HostedZoneId": "Z2R2ITUGPM61AM", + "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "CopyTagsToSnapshot": false + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action applies only to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To create a custom DB cluster endpoint", + "documentation": "The following example creates a custom DB cluster endpoint and associate it with the specified Aurora DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointIdentifier": "mycustomendpoint", + "EndpointType": "reader", + "StaticMembers": ["dbinstance1", "dbinstance2"] }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#RebootDBInstance": { - "type": "operation", + "output": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": ["dbinstance1", "dbinstance2"], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the endpoint, one of: READER, WRITER, ANY.

", + "smithy.api#required": {} + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n This parameter is relevant only if the list of static members is empty.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBClusterMessage": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

\n

For information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35.

    \n
    • \n
" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the character set (CharacterSet) to associate the DB cluster with.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you don't\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for this DB cluster. This parameter is stored as a lowercase string.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with this DB cluster. If you don't specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \n
" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB subnet group.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres\n

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible),\n use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or\n version 3, respectively.

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

For information about a specific engine, see the following topics:

\n \n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    RDS for MySQL and Aurora MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for PostgreSQL and Aurora PostgreSQL - 5432\n

    \n
    • \n
" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB cluster with.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "ReplicationSourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When a KMS key isn't specified in KmsKeyId:

\n
    \n
  • \n

    If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS uses the KMS key used to encrypt the\n source. Otherwise, Amazon RDS uses your default KMS key.

    \n
    • \n
  • \n

    If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n uses your default KMS key.

    \n
    • \n
\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make\n sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n
    \n
  • \n

    \n KmsKeyId - The KMS key identifier for the KMS key to use to\n encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should\n refer to the same KMS key for both the CreateDBCluster operation\n that is called in the destination Amazon Web Services Region, and the operation contained in\n the presigned URL.

    \n
    • \n
  • \n

    \n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.

    \n
    • \n
  • \n

    \n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Valid for Cluster Type: Aurora MySQL DB clusters only

\n

Default: 0\n

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\n

For information about limitations and requirements for Serverless DB clusters, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "EnableHttpEndpoint": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB cluster in.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "EnableGlobalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

This setting is required to create a Multi-AZ DB cluster.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    Aurora DB clusters - aurora | aurora-iopt1\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
\n

Default:

\n
    \n
  • \n

    Aurora DB clusters - aurora\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
\n \n

When you create an Aurora DB cluster with the storage type set to aurora-iopt1, the storage type is returned\n in the response. The storage type isn't returned when you set it to aurora.

\n " + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS\n User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

    \n
    • \n
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB cluster parameter group.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

\n

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.

\n

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To create a DB cluster parameter group", + "documentation": "The following example creates a DB cluster parameter group.", "input": { - "target": "com.amazonaws.rds#RebootDBInstanceMessage" + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group" }, "output": { - "target": "com.amazonaws.rds#RebootDBInstanceResult" + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must not match the name of an existing DB cluster parameter group.

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#required": {} + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora-mysql5.7, aurora-mysql8.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql14\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres12\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB cluster parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB cluster parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroupResult": { + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#DBClusterParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a DB cluster.

\n

For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To create a DB cluster snapshot", + "documentation": "The following example creates a DB cluster snapshot.", + "input": { + "DBClusterSnapshotIdentifier": "mydbcluster", + "DBClusterIdentifier": "mydbclustersnapshot" }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.

\n

Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

\n

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

\n

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

", - "smithy.api#examples": [ - { - "title": "To reboot a DB instance", - "documentation": "The following example starts a reboot of the specified DB instance.", - "input": { - "DBInstanceIdentifier": "test-mysql-instance" - }, - "output": { - "DBInstance": { - "DBInstanceIdentifier": "test-mysql-instance", - "DBInstanceClass": "db.t3.micro", - "Engine": "mysql", - "DBInstanceStatus": "rebooting", - "MasterUsername": "admin", - "Endpoint": { - "Address": "test-mysql-instance.############.us-west-2.rds.amazonaws.com", - "Port": 3306, - "HostedZoneId": "Z1PVIF0EXAMPLE" - } - } - } - } - ] - } + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": ["us-east-1a", "us-east-1b", "us-east-1e"], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 1, + "Status": "creating", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 0, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1-snapshot1\n

", + "smithy.api#required": {} + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, - "com.amazonaws.rds#RebootDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ForceFailover": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, - "com.amazonaws.rds#RebootDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" }, - "com.amazonaws.rds#RecurringCharge": { - "type": "structure", - "members": { - "RecurringChargeAmount": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of the recurring charge.

" - } - }, - "RecurringChargeFrequency": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The frequency of the recurring charge.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" - } + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, - "com.amazonaws.rds#RecurringChargeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#RecurringCharge", - "traits": { - "smithy.api#xmlName": "RecurringCharge" - } - } + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, - "com.amazonaws.rds#RegisterDBProxyTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RegisterDBProxyTargetsRequest" - }, - "output": { - "target": "com.amazonaws.rds#RegisterDBProxyTargetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

" - } + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, - "com.amazonaws.rds#RegisterDBProxyTargetsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", - "smithy.api#required": {} - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" - } - }, - "DBInstanceIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more DB instance identifiers.

" - } - }, - "DBClusterIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more DB cluster identifiers.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, - "com.amazonaws.rds#RegisterDBProxyTargetsResponse": { - "type": "structure", - "members": { - "DBProxyTargets": { - "target": "com.amazonaws.rds#TargetList", - "traits": { - "smithy.api#documentation": "

One or more DBProxyTarget objects that are created when you register targets with a target group.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, - "com.amazonaws.rds#RemoveFromGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveFromGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#RemoveFromGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To detach an Aurora secondary cluster from an Aurora global database cluster", - "documentation": "The following example detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster changes from being read-only to a standalone cluster with read-write capability.", - "input": { - "GlobalClusterIdentifier": "myglobalcluster", - "DbClusterIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" - }, - "output": { - "GlobalCluster": { - "GlobalClusterIdentifier": "myglobalcluster", - "GlobalClusterResourceId": "cluster-abc123def456gh", - "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", - "Status": "available", - "Engine": "aurora-postgresql", - "EngineVersion": "10.11", - "StorageEncrypted": true, - "DeletionProtection": false, - "GlobalClusterMembers": [ - { - "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster", - "Readers": [ - "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" - ], - "IsWriter": true - }, - { - "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1", - "Readers": [], - "IsWriter": false, - "GlobalWriteForwardingStatus": "disabled" - } - ] - } - } - } - ] - } + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, - "com.amazonaws.rds#RemoveFromGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The cluster identifier to detach from the Aurora global database cluster.

" - } - }, - "DbClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DomainNotFoundFault" }, - "com.amazonaws.rds#RemoveFromGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, - "com.amazonaws.rds#RemoveRoleFromDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveRoleFromDBClusterMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterRoleNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", - "smithy.api#examples": [ - { - "title": "To disassociate an Identity and Access Management (IAM) role from a DB cluster", - "documentation": "The following example removes a role from a DB cluster.", - "input": { - "DBClusterIdentifier": "mydbcluster", - "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" - } - } - ] - } + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, - "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster to disassociate the IAM role from.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example\n arn:aws:iam::123456789012:role/AuroraAccessRole.

", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, - "com.amazonaws.rds#RemoveRoleFromDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceRoleNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

" - } + { + "target": "com.amazonaws.rds#InvalidSubnet" }, - "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB instance to disassociate the IAM role from.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance,\n for example, arn:aws:iam::123456789012:role/AccessRole.

", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, - "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#SourceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a source identifier from an existing RDS event notification subscription.

", - "smithy.api#examples": [ - { - "title": "To remove a source identifier from a subscription", - "documentation": "The following example removes the specified source identifier from an existing subscription.", - "input": { - "SubscriptionName": "my-instance-events", - "SourceIdentifier": "test-instance-repl" - }, - "output": { - "EventSubscription": { - "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", - "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", - "EventCategoriesList": [ - "backup", - "recovery" - ], - "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", - "Status": "modifying", - "CustSubscriptionId": "my-instance-events", - "CustomerAwsId": "123456789012", - "SourceIdsList": [ - "test-instance" - ], - "SourceType": "db-instance", - "Enabled": false - } - } - } - ] - } + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, - "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription you want to remove a source identifier from.

", - "smithy.api#required": {} - } - }, - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" }, - "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" }, - "com.amazonaws.rds#RemoveTagsFromResource": { - "type": "operation", + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance.

\n

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

\n

For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

\n

For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a DB instance", + "documentation": "The following example uses the required options to launch a new DB instance.", "input": { - "target": "com.amazonaws.rds#RemoveTagsFromResourceMessage" + "DBInstanceIdentifier": "test-mysql-instance", + "AllocatedStorage": 20, + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "MasterUsername": "admin", + "MasterUserPassword": "secret99" }, "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Removes metadata tags from an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n

", - "smithy.api#examples": [ + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "MasterUsername": "admin", + "AllocatedStorage": 20, + "PreferredBackupWindow": "12:55-13:25", + "BackupRetentionPeriod": 1, + "DBSecurityGroups": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-12345abc", + "Status": "active" + } + ], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.7", + "ParameterApplyStatus": "in-sync" + } + ], + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-2ff2ff2f", + "SubnetGroupStatus": "Complete", + "Subnets": [ { - "title": "To remove tags from a resource", - "documentation": "The following example removes tags from a resource.", - "input": { - "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:mydbinstance", - "TagKeys": [ - "Name", - "Environment" - ] - } - } - ] - } - }, - "com.amazonaws.rds#RemoveTagsFromResourceMessage": { - "type": "structure", - "members": { - "ResourceName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

", - "smithy.api#required": {} + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" } + ] }, - "TagKeys": { - "target": "com.amazonaws.rds#KeyList", - "traits": { - "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } + "PreferredMaintenanceWindow": "sun:08:07-sun:08:37", + "PendingModifiedValues": { + "MasterUserPassword": "****" + }, + "MultiAZ": false, + "EngineVersion": "5.7.22", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "OptionGroupMemberships": [ + { + "OptionGroupName": "default:mysql-5-7", + "Status": "in-sync" + } + ], + "PubliclyAccessible": true, + "StorageType": "gp2", + "DbInstancePort": 0, + "StorageEncrypted": false, + "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE", + "CACertificateIdentifier": "rds-ca-2019", + "DomainMemberships": [], + "CopyTagsToSnapshot": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false, + "DeletionProtection": false, + "AssociatedRoles": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBInstanceMessage": { + "type": "structure", + "members": { + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \n
\n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \n
\n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
    • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
    • \n
  • \n

    Can't be a word reserved by the specified database engine

    \n
    • \n
\n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters

    \n
    • \n
\n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 8 alphanumeric characters.

    \n
    • \n
  • \n

    It must contain a letter.

    \n
    • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
    • \n
\n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 64 alphanumeric characters.

    \n
    • \n
  • \n

    It can't be a word reserved by the database engine.

    \n
    • \n
\n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
    • \n
  • \n

    It must begin with a letter.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
    • \n
  • \n

    It can't be a word reserved by the\n database engine.

    \n
    • \n
" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for this DB instance. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n
\n
Amazon RDS Custom
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.

    \n
    • \n
\n
\n
RDS for MariaDB
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for MySQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for Oracle
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n
\n
RDS for PostgreSQL
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n
\n
RDS for SQL Server
\n
\n

Constraints to the amount of storage for each storage type are the following:

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2, gp3):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 100 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

      \n
      • \n
    \n
    • \n
  • \n

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 20 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \n
    • \n
\n
\n
" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for this DB instance.

\n

Not every database engine is available in every Amazon Web Services Region.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql (for Aurora MySQL DB instances)

    \n
    • \n
  • \n

    \n aurora-postgresql (for Aurora PostgreSQL DB instances)

    \n
    • \n
  • \n

    \n custom-oracle-ee (for RDS Custom for Oracle DB instances)

    \n
    • \n
  • \n

    \n custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-se (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n custom-sqlserver-web (for RDS Custom for SQL Server DB instances)

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster.

\n

This setting is required for RDS DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters, numbers, or underscores.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master user.

\n

This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB\n cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
    • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
    • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
    • \n
" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

This setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Constraints:

\n
    \n
  • \n

    The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.

    \n
    • \n
  • \n

    The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

    \n
    • \n
\n

Example: us-east-1d\n

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB subnet group.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each week during which system maintenance can occur. \n For more information, see Amazon RDS Maintenance Window \n in the Amazon RDS User Guide.\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    The day values must be mon | tue | wed | thu | fri | sat | sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then \n Amazon RDS uses the default DB parameter group for the specified DB engine and version.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas.

    \n
    • \n
  • \n

    Can't be set to 0 for an RDS Custom for Oracle DB instance.

    \n
    • \n
" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    RDS for MariaDB - 3306\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - 1433\n

    \n
    • \n
  • \n

    RDS for MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for Oracle - 1521\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - 5432\n

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    For RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.

    \n
    • \n
" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB\n instance uses is managed by the DB cluster.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n
\n
Amazon RDS Custom for Oracle
\n
\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n
\n
Amazon RDS Custom for SQL Server
\n
\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n
\n
RDS for MariaDB
\n
\n

For information, see MariaDB on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Microsoft SQL Server
\n
\n

For information, see Microsoft SQL Server versions on Amazon RDS in the \n Amazon RDS User Guide.

\n
\n
RDS for MySQL
\n
\n

For information, see MySQL on Amazon RDS versions in the \n Amazon RDS User Guide.

\n
\n
RDS for Oracle
\n
\n

For information, see Oracle Database Engine release notes in the \n Amazon RDS User Guide.

\n
\n
RDS for PostgreSQL
\n
\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n
\n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for this DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
    • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
    • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 \n of the storage amount for the DB instance.

    \n
    • \n
  • \n

    For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB instance with.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

For supported engines, the character set (CharacterSet) to associate the DB instance with.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora - The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

    \n
    • \n
  • \n

    RDS Custom - However, if you need to change the character set, \n you can change it on the database itself.

    \n
    • \n
" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB instance is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB instance is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB instance is public.

    \n
    • \n
" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB instance.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster that this DB instance will belong to.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifes whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error.

\n

This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL \n Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The domain is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The domain is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: 1\n

\n

Valid Values: 0 - 15\n

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    RDS for MariaDB - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - agent | error\n

    \n
    • \n
  • \n

    RDS for MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for Oracle - alert | audit | listener | trace | oemagent\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (Storage is managed by the DB cluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance.

\n

This setting is required for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The location for storing automated backups and manual snapshots.

\n

Valie Values:

\n
    \n
  • \n

    \n outposts (Amazon Web Services Outposts)

    \n
    • \n
  • \n

    \n region (Amazon Web Services Region)

    \n
    • \n
\n

Default: region\n

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. In this context, the term \"Oracle database instance\" refers exclusively \n to the system global area (SGA) and Oracle background processes. If you don't specify a SID, \n the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, - "com.amazonaws.rds#ReplicaMode": { - "type": "enum", - "members": { - "OPEN_READ_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open-read-only" - } - }, - "MOUNTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mounted" - } - } - } + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, - "com.amazonaws.rds#ReservedDBInstance": { - "type": "structure", - "members": { - "ReservedDBInstanceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The unique identifier for the reservation.

" - } - }, - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering identifier.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" - } - }, - "StartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time the reservation started.

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the reservation in seconds.

" - } - }, - "FixedPrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The fixed price charged for this reserved DB instance.

" - } - }, - "UsagePrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The hourly price charged for this reserved DB instance.

" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The currency code for the reserved DB instance.

" - } - }, - "DBInstanceCount": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of reserved DB instances.

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the reserved DB instance.

" - } - }, - "OfferingType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering type of this reserved DB instance.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the reservation applies to Multi-AZ deployments.

" - } - }, - "State": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The state of the reserved DB instance.

" - } - }, - "RecurringCharges": { - "target": "com.amazonaws.rds#RecurringChargeList", - "traits": { - "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" - } - }, - "ReservedDBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the reserved DB instance.

" - } - }, - "LeaseId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.

" - } + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, - "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReservedDBInstanceAlreadyExists", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

User already has a reservation with the given identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, - "com.amazonaws.rds#ReservedDBInstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ReservedDBInstance", - "traits": { - "smithy.api#xmlName": "ReservedDBInstance" - } - } + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, - "com.amazonaws.rds#ReservedDBInstanceMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "ReservedDBInstances": { - "target": "com.amazonaws.rds#ReservedDBInstanceList", - "traits": { - "smithy.api#documentation": "

A list of reserved DB instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

", - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, - "com.amazonaws.rds#ReservedDBInstanceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReservedDBInstanceNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified reserved DB Instance not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } + { + "target": "com.amazonaws.rds#DBSubnetGroupNotAllowedFault" }, - "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReservedDBInstanceQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Request would exceed the user's DB Instance quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, - "com.amazonaws.rds#ReservedDBInstancesOffering": { - "type": "structure", - "members": { - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering identifier.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the offering in seconds.

" - } - }, - "FixedPrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The fixed price charged for this offering.

" - } - }, - "UsagePrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The hourly price charged for this offering.

" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The currency code for the reserved DB instance offering.

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine used by the offering.

" - } - }, - "OfferingType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering type.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the offering applies to Multi-AZ deployments.

" - } - }, - "RecurringCharges": { - "target": "com.amazonaws.rds#RecurringChargeList", - "traits": { - "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" - } + { + "target": "com.amazonaws.rds#DomainNotFoundFault" }, - "com.amazonaws.rds#ReservedDBInstancesOfferingList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ReservedDBInstancesOffering", - "traits": { - "smithy.api#xmlName": "ReservedDBInstancesOffering" - } - } + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, - "com.amazonaws.rds#ReservedDBInstancesOfferingMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "ReservedDBInstancesOfferings": { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingList", - "traits": { - "smithy.api#documentation": "

A list of reserved DB instance offerings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

", - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, - "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReservedDBInstancesOfferingNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

Specified offering does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, - "com.amazonaws.rds#ResetDBClusterParameterGroup": { - "type": "operation", + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running\n MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a\n Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working\n with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.

\n

All read replica DB instances are created with backups disabled. All other attributes\n (including DB security groups and DB parameter groups) are inherited from the source DB\n instance or cluster, except as specified.

\n \n

Your source DB instance or cluster must have backup retention enabled.

\n ", + "smithy.api#examples": [ + { + "title": "To create a DB instance read replica", + "documentation": "This example creates a read replica of an existing DB instance named test-instance. The read replica is named test-instance-repl.", "input": { - "target": "com.amazonaws.rds#ResetDBClusterParameterGroupMessage" + "DBInstanceIdentifier": "test-instance-repl", + "SourceDBInstanceIdentifier": "test-instance" }, "output": { - "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" + "DBInstance": { + "IAMDatabaseAuthenticationEnabled": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceIdentifier": "test-instance-repl" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier of the read replica. This identifier is the unique key\n that identifies a DB instance. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "SourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL\n Server, which can have up to five.

\n

Constraints:

\n
    \n
  • \n

    Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.

    \n
    • \n
  • \n

    Can't be specified if the SourceDBClusterIdentifier parameter is\n also specified.

    \n
    • \n
  • \n

    For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the\n Amazon RDS User Guide.

    \n
    • \n
  • \n

    For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.

    \n
    • \n
  • \n

    The specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.

    \n
    • \n
  • \n

    If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.

    \n
    • \n
  • \n

    If the source DB instance is in a different Amazon Web Services Region from the read\n replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User\n Guide. This doesn't apply to SQL Server or RDS Custom, which\n don't support cross-Region replicas.

    \n
    • \n
" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: Inherits from the source DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the read replica is in a Multi-AZ deployment.

\n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your\n replica in another Availability Zone for failover support for the replica. Creating your\n read replica as a Multi-AZ DB instance is independent of whether the source is a\n Multi-AZ DB instance or a Multi-AZ DB cluster.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Inherits from the source DB instance

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group the DB instance is associated with. If omitted, the option group\n associated with the source instance or cluster is used.

\n \n

For SQL Server, you must use the option group associated with the source.

\n \n

This setting doesn't apply to RDS Custom.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBSubnetGroup.

    \n
    • \n
  • \n

    The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

    \n
    • \n
  • \n

    All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>

    \n
      \n
    • \n

      Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

      \n
      • \n
    • \n

      Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

      \n
      • \n
    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the read replica.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted read replica.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read\n replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source\n DB instance or cluster.

\n

If you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance or\n Multi-AZ DB cluster.

\n

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

This setting applies only when replicating from a source DB\n instance. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n
    \n
  • \n

    \n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica operation is called that contains\n this presigned URL.

    \n

    For example, if you create an encrypted DB instance in the us-west-1\n Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you\n call the CreateDBInstanceReadReplica operation in the us-east-1\n Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica operation in the us-west-2\n Amazon Web Services Region. For this example, the DestinationRegion in the\n presigned URL must be set to the us-east-1 Amazon Web Services Region.

    \n
    • \n
  • \n

    \n KmsKeyId - The KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica operation that\n is called in the destination Amazon Web Services Region, and the operation contained in the\n presigned URL.

    \n
    • \n
  • \n

    \n SourceDBInstanceIdentifier - The DB instance identifier for the\n encrypted DB instance to be replicated. This identifier must be in the Amazon\n Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are\n creating an encrypted read replica from a DB instance in the us-west-2\n Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

    \n
    • \n
\n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory\n Service.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

The open mode of the replica database: mounted or read-only.

\n \n

This parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the read replica.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough storage for your read replica so that the create operation can succeed.\n You can also allocate additional storage for future growth.

\n " + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Multi-AZ DB cluster that will act as the source for the read\n replica. Each DB cluster can have up to 15 read replicas.

\n

Constraints:

\n
    \n
  • \n

    Must be the identifier of an existing Multi-AZ DB cluster.

    \n
    • \n
  • \n

    Can't be specified if the SourceDBInstanceIdentifier parameter is\n also specified.

    \n
    • \n
  • \n

    The specified DB cluster must have automatic backups enabled, that is, its\n backup retention period must be greater than 0.

    \n
    • \n
  • \n

    The source DB cluster must be in the same Amazon Web Services Region as the read replica.\n Cross-Region replication isn't supported.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB parameter group.

\n

A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.

\n

This command doesn't apply to RDS Custom.

\n \n

After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n ", + "smithy.api#examples": [ + { + "title": "To create a DB parameter group", + "documentation": "The following example creates a DB parameter group.", + "input": { + "DBParameterGroupName": "mydbparametergroup", + "DBParameterGroupFamily": "MySQL8.0", + "Description": "My new parameter group" }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.

\n

When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", - "smithy.api#examples": [ - { - "title": "To reset all parameters to their default values", - "documentation": "The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.", - "input": { - "DBClusterParameterGroupName": "mydbclpg", - "ResetAllParameters": true - }, - "output": { - "DBClusterParameterGroupName": "mydbclpg" - } - } - ] + "output": { + "DBParameterGroup": { + "DBParameterGroupName": "mydbparametergroup", + "DBParameterGroupFamily": "mysql8.0", + "Description": "My new parameter group", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#required": {} + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBParameterGroupResult": { + "type": "structure", + "members": { + "DBParameterGroup": { + "target": "com.amazonaws.rds#DBParameterGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB proxy.

" + } + }, + "com.amazonaws.rds#CreateDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters.\n You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use\n DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

" + } + }, + "com.amazonaws.rds#CreateDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#DBProxyName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy associated with the DB proxy endpoint that you create.

", + "smithy.api#required": {} + } + }, + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy endpoint to create.

", + "smithy.api#required": {} + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a\n different set of subnet IDs than for the original DB proxy.

", + "smithy.api#required": {} + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint that you create. You can\n specify a different set of security group IDs than for the original DB proxy.\n The default is the default security group for the VPC.

" + } + }, + "TargetRole": { + "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The DBProxyEndpoint object that is created by the API operation.\n The DB proxy endpoint that you create might provide capabilities such as read/write\n or read-only operations, or using a different VPC than the proxy's default VPC.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

", + "smithy.api#required": {} + } + }, + "EngineFamily": { + "target": "com.amazonaws.rds#EngineFamily", + "traits": { + "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. \n For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify \n SQLSERVER.

", + "smithy.api#required": {} + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigList", + "traits": { + "smithy.api#documentation": "

The authorization mechanism that the proxy uses.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

", + "smithy.api#required": {} + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more VPC subnet IDs to associate with the new proxy.

", + "smithy.api#required": {} + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more VPC security group IDs to associate with the new proxy.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The DBProxy structure corresponding to the new proxy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSecurityGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSecurityGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To create a DB security group.", + "documentation": "This example creates a DB security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "DBSecurityGroupDescription": "My DB security group" + }, + "output": { + "DBSecurityGroup": {} } - }, - "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to reset.

", - "smithy.api#required": {} - } - }, - "ResetAllParameters": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.

" - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this\n parameter if the ResetAllParameters parameter is enabled.

" - } - } + } + ] + } + }, + "com.amazonaws.rds#CreateDBSecurityGroupMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB security group. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \n
\n

Example: mysecuritygroup\n

", + "smithy.api#required": {} + } + }, + "DBSecurityGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB security group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBSecurityGroupResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.

", + "smithy.api#examples": [ + { + "title": "To create a DB snapshot", + "documentation": "The following example creates a DB snapshot.", + "input": { + "DBSnapshotIdentifier": "database-mysql", + "DBInstanceIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "creating", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "8.0.32", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-8-0", + "PercentProgress": 0, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Can't be null, empty, or blank

    \n
    • \n
  • \n

    Must contain from 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

", + "smithy.api#required": {} + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB instance that you want to create the snapshot of.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSubnetGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

", + "smithy.api#examples": [ + { + "title": "To create a DB subnet group", + "documentation": "The following example creates a DB subnet group called mysubnetgroup using existing subnets.", + "input": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "SubnetIds": ["subnet-0a1dc4e1a6f123456", "subnet-070dd7ecb3aaaaaaa", "subnet-00f5b198bc0abcdef"] }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} + "output": { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup" + } } - }, - "com.amazonaws.rds#ResetDBParameterGroup": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.rds#CreateDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

    \n
    • \n
  • \n

    Must not be default.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB subnet group.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.rds#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

The EC2 Subnet IDs for the DB subnet group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB subnet group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateDBSubnetGroupResult": { + "type": "structure", + "members": { + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#SNSInvalidTopicFault" + }, + { + "target": "com.amazonaws.rds#SNSNoAuthorizationFault" + }, + { + "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionAlreadyExistFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n

For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

\n

For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To create an event subscription", + "documentation": "The following example creates a subscription for backup and recovery events for DB instances in the current AWS account. Notifications are sent to an Amazon Simple Notification Service topic.", "input": { - "target": "com.amazonaws.rds#ResetDBParameterGroupMessage" + "SubscriptionName": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "EventCategories": ["backup", "recovery"] }, "output": { - "target": "com.amazonaws.rds#DBParameterGroupNameMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

", - "smithy.api#examples": [ - { - "title": "To reset all parameters to their default values", - "documentation": "The following example resets all parameter values in a customer-created DB parameter group to their default values.", - "input": { - "DBParameterGroupName": "mypg", - "ResetAllParameters": true - }, - "output": { - "DBParameterGroupName": "mypg" - } - } - ] - } - }, - "com.amazonaws.rds#ResetDBParameterGroupMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBParameterGroup.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ResetAllParameters": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.

" - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

\n

\n MySQL\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n MariaDB\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n Oracle\n

\n

Valid Values (for Apply method): pending-reboot\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#ResourceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } + "EventSubscription": { + "Status": "creating", + "CustSubscriptionId": "my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": ["backup", "recovery"], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustomerAwsId": "123456789012", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SourceType": "db-instance", + "Enabled": true + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", + "smithy.api#required": {} + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .\n You can also see this list by using the DescribeEventCategories operation.

" + } + }, + "SourceIds": { + "target": "com.amazonaws.rds#SourceIdsList", + "traits": { + "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

\n

Constraints:

\n
    \n
  • \n

    If SourceIds are supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
" + } + }, + "Enabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

\n

You can create a global database that is initially empty, and then \n create the primary and secondary DB clusters in the global database.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

\n \n

This operation applies only to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To create a global DB cluster", + "documentation": "The following example creates a new Aurora MySQL-compatible global DB cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster", + "Engine": "aurora-mysql" }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified resource ID was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#ResourcePendingMaintenanceActions": { - "type": "structure", - "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN of the resource that has pending maintenance actions.

" - } - }, - "PendingMaintenanceActionDetails": { - "target": "com.amazonaws.rds#PendingMaintenanceActionDetails", - "traits": { - "smithy.api#documentation": "

A list that provides details about the pending maintenance actions for the resource.

" - } - } + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

" + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

\n

If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

\n
    \n
  • \n

    \n DatabaseName\n

    \n
    • \n
  • \n

    \n Engine\n

    \n
    • \n
  • \n

    \n EngineVersion\n

    \n
    • \n
  • \n

    \n StorageEncrypted\n

    \n
    • \n
" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for this global database cluster.

\n

Valid Values: aurora-mysql | aurora-postgresql\n

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

    \n
    • \n
" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version to use for this global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

    \n
    • \n
" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the new global database cluster.\n The global database can't be deleted when deletion protection is enabled.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you don't specify\n a name, Amazon Aurora doesn't create a database in the global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.

    \n
    • \n
" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable storage encryption for the new global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CreateOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new option group. You can create up to 20 option groups.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To Create an Amazon RDS option group", + "documentation": "The following example creates a new Amazon RDS option group for Oracle MySQL version 8,0 named MyOptionGroup.", + "input": { + "OptionGroupName": "MyOptionGroup", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "OptionGroupDescription": "MySQL 8.0 option group" }, - "traits": { - "smithy.api#documentation": "

Describes the pending maintenance actions for a resource.

" - } - }, - "com.amazonaws.rds#RestoreDBClusterFromS3": { - "type": "operation", + "output": { + "OptionGroup": { + "OptionGroupName": "myoptiongroup", + "OptionGroupDescription": "MySQL 8.0 option group", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" + } + } + } + ] + } + }, + "com.amazonaws.rds#CreateOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group to be created.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: myoptiongroup\n

", + "smithy.api#required": {} + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the major version of the engine that this option group should be associated with.

", + "smithy.api#required": {} + } + }, + "OptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#CreateOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomAvailabilityZoneNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n CustomAvailabilityZoneId doesn't refer to an existing custom\n Availability Zone identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionAMI": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the ID of the AMI.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the status of a custom engine version (CEV).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A value that indicates the AMI information.

" + } + }, + "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A CEV with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionManifest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified CEV was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded your CEV quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CustomEngineName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 35 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]{1,35}$" + } + }, + "com.amazonaws.rds#CustomEngineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[a-z0-9_.-]{1,60}$" + } + }, + "com.amazonaws.rds#CustomEngineVersionStatus": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive" + } + }, + "inactive_except_restore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive-except-restore" + } + } + } + }, + "com.amazonaws.rds#DBCluster": { + "type": "structure", + "members": { + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the character set that this cluster is associated with.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

" + } + }, + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group for the DB cluster.

" + } + }, + "DBSubnetGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current state of this DB cluster.

" + } + }, + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when a stopped DB cluster is restarted automatically.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The progress of the operation as a percentage.

" + } + }, + "EarliestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time to which a database can be restored with point-in-time\n restore.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The connection endpoint for the primary instance of the DB cluster.

" + } + }, + "ReaderEndpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

\n

If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

" + } + }, + "CustomEndpoints": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The custom endpoints associated with the DB cluster.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster has instances in multiple Availability Zones.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine used for this DB cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine.

" + } + }, + "LatestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The latest time to which a database can be restored with point-in-time restore.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port that the database engine is listening on.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master username for the DB cluster.

" + } + }, + "DBClusterOptionGroupMemberships": { + "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", + "traits": { + "smithy.api#documentation": "

The list of option group memberships for this DB cluster.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + } + }, + "ReplicationSourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB cluster if this DB cluster is a read\n replica.

" + } + }, + "ReadReplicaIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaIdentifierList", + "traits": { + "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n cluster.

" + } + }, + "DBClusterMembers": { + "target": "com.amazonaws.rds#DBClusterMemberList", + "traits": { + "smithy.api#documentation": "

The list of DB instances that make up the DB cluster.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

The list of VPC security groups that the DB cluster belongs to.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DB cluster is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever \n the KMS key for the DB cluster is accessed.

" + } + }, + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster.

" + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.rds#DBClusterRoles", + "traits": { + "smithy.api#documentation": "

A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "CloneGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the clone group with which the DB cluster is associated.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + } + }, + "EarliestBacktrackTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time to which a DB cluster can be backtracked.

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

" + } + }, + "BacktrackConsumedChangeRecords": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The number of change records stored for Backtrack.

" + } + }, + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

" + } + }, + "Capacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

For more information, see \n CreateDBCluster.

" + } + }, + "ScalingConfigurationInfo": { + "target": "com.amazonaws.rds#ScalingConfigurationInfo" + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.

" + } + }, + "HttpEndpointEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" + } + }, + "ActivityStreamMode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

" + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "ActivityStreamKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "ActivityStreamKinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

" + } + }, + "CrossAccountClone": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

" + } + }, + "DomainMemberships": { + "target": "com.amazonaws.rds#DomainMembershipList", + "traits": { + "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB cluster.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "GlobalWriteForwardingStatus": { + "target": "com.amazonaws.rds#WriteForwardingStatus", + "traits": { + "smithy.api#documentation": "

The status of write forwarding for a secondary cluster in an Aurora global database.

" + } + }, + "GlobalWriteForwardingRequested": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether write forwarding is enabled for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#ClusterPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB cluster.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBCluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "MasterUserSecret": { + "target": "com.amazonaws.rds#MasterUserSecret", + "traits": { + "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" + } + }, + "IOOptimizedNextAllowedModificationTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

\n

This setting is only for Aurora DB clusters.

" + } + }, + "LocalWriteForwardingStatus": { + "target": "com.amazonaws.rds#LocalWriteForwardingStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process \n of enabling it.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } + }, + "com.amazonaws.rds#DBClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB cluster with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackup": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine for this automated backup.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The VPC ID associated with the DB cluster.

" + } + }, + "DBClusterAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the automated backups.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "RestoreWindow": { + "target": "com.amazonaws.rds#RestoreWindow" + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master user name of the automated backup.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "Region": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for this DB cluster automated backup.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A list of status information for an automated backup:

\n
    \n
  • \n

    \n retained - Automated backups for deleted clusters.

    \n
    • \n
" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and \n otherwise false.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the source DB cluster is encrypted.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine for the automated backup.

" + } + }, + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the source DB cluster.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The retention period for the automated backups.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine mode of the database engine for the automated backup.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

The Availability Zones where instances in the DB cluster can be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB cluster

\n

Valid Values: 1150-65535\n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster \n properties that existed at the time you deleted the source cluster.

" + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackup", + "traits": { + "smithy.api#xmlName": "DBClusterAutomatedBackup" + } + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.

" + } + }, + "DBClusterAutomatedBackups": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupList", + "traits": { + "smithy.api#documentation": "

A list of DBClusterAutomatedBackup backups.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAutomatedBackupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

No automated backup for this DB cluster was found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAutomatedBackupQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated \n backups. The retained automated backups quota is the same as your DB cluster quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterBacktrack": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" + } + }, + "BacktrackIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the backtrack identifier.

" + } + }, + "BacktrackTo": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time to which the DB cluster was backtracked.

" + } + }, + "BacktrackedFrom": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time from which the DB cluster was backtracked.

" + } + }, + "BacktrackRequestCreationTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time at which the backtrack was requested.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the backtrack. This property returns one of the following\n values:

\n
    \n
  • \n

    \n applying - The backtrack is currently being applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

    \n
    • \n
  • \n

    \n pending - The backtrack is currently pending application to or rollback from the DB cluster.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBClusterBacktracks action.

" + } + }, + "com.amazonaws.rds#DBClusterBacktrackList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterBacktrack", + "traits": { + "smithy.api#xmlName": "DBClusterBacktrack" + } + } + }, + "com.amazonaws.rds#DBClusterBacktrackMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusterBacktracks request.

" + } + }, + "DBClusterBacktracks": { + "target": "com.amazonaws.rds#DBClusterBacktrackList", + "traits": { + "smithy.api#documentation": "

Contains a list of backtracks for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterBacktrackNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterBacktrackNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n BacktrackIdentifier doesn't refer to an existing backtrack.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterCapacityInfo": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" + } + }, + "PendingCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the capacity that the DB cluster scales to next.

" + } + }, + "CurrentCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The current capacity of the DB cluster.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.

" + } + } + } + }, + "com.amazonaws.rds#DBClusterEndpoint": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" + } + }, + "DBClusterEndpointResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DNS address of the endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster,\n such as a writer endpoint for a read-only secondary cluster in a global database.

" + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, CUSTOM.

" + } + }, + "CustomEndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type associated with a custom endpoint. One of: READER,\n WRITER, ANY.

" + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" + } + }, + "DBClusterEndpointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n ModifyDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DeleteDBClusterEndpoint\n

    \n
    • \n
\n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" + } + }, + "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified custom endpoint can't be created because it already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterEndpoint", + "traits": { + "smithy.api#xmlName": "DBClusterEndpointList" + } + } + }, + "com.amazonaws.rds#DBClusterEndpointMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterEndpoints": { + "target": "com.amazonaws.rds#DBClusterEndpointList", + "traits": { + "smithy.api#documentation": "

Contains the details of the endpoints associated with the cluster\n and matching any filter conditions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterEndpointNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointNotFoundFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified custom endpoint doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointQuotaExceededFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The cluster already has the maximum number of custom endpoints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#DBClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#DBClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBCluster", + "traits": { + "smithy.api#xmlName": "DBCluster" + } + } + }, + "com.amazonaws.rds#DBClusterMember": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance identifier for this member of the DB cluster.

" + } + }, + "IsClusterWriter": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

" + } + }, + "DBClusterParameterGroupStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an instance that is part of a DB cluster.

" + } + }, + "com.amazonaws.rds#DBClusterMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterMember", + "traits": { + "smithy.api#xmlName": "DBClusterMember" + } + } + }, + "com.amazonaws.rds#DBClusterMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusters request.

" + } + }, + "DBClusters": { + "target": "com.amazonaws.rds#DBClusterList", + "traits": { + "smithy.api#documentation": "

Contains a list of DB clusters for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusters action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterOptionGroupMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterOptionGroupStatus", + "traits": { + "smithy.api#xmlName": "DBClusterOptionGroup" + } + } + }, + "com.amazonaws.rds#DBClusterOptionGroupStatus": { + "type": "structure", + "members": { + "DBClusterOptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB cluster option group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of the DB cluster option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains status information for a DB cluster option group.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroup": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family that this DB cluster parameter group is compatible with.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the customer-specified description for this DB cluster parameter group.

" + } + }, + "DBClusterParameterGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB cluster parameter group.

\n

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupDetails": { + "type": "structure", + "members": { + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

Provides a list of parameters for the DB cluster parameter group.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterParameterGroup", + "traits": { + "smithy.api#xmlName": "DBClusterParameterGroup" + } + } + }, + "com.amazonaws.rds#DBClusterParameterGroupNameMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n \n

This value is stored as a lowercase string.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterParameterGroupsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterParameterGroups": { + "target": "com.amazonaws.rds#DBClusterParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster parameter groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterQuotaExceededFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The user attempted to create a new DB cluster and the user has already reached the\n maximum allowed DB cluster quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#DBClusterRole": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to\n access other Amazon Web Services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB cluster.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable\n to assume the IAM role in order to access other Amazon Web Services on your behalf.

    \n
    • \n
" + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

" + } + }, + "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterRoleQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterRole", + "traits": { + "smithy.api#xmlName": "DBClusterRole" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshot": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

" + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the identifier for the DB cluster snapshot.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the database engine for this DB cluster snapshot.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the engine mode of the database engine for this DB cluster snapshot.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

\n
    \n
  • \n

    \n available\n

    \n
    • \n
  • \n

    \n copying\n

    \n
    • \n
  • \n

    \n creating\n

    \n
    • \n
" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID associated with the DB cluster snapshot.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the master username for this DB cluster snapshot.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the version of the database engine for this DB cluster snapshot.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the license model information for this DB cluster snapshot.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the type of the DB cluster snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the DB cluster snapshot is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DBClusterSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the DB cluster snapshot.

" + } + }, + "SourceDBClusterSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB cluster snapshot.

\n

This setting is only for Aurora DB clusters.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the resource ID of the DB cluster that this DB cluster snapshot was created from.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB cluster snapshot

\n

This data type is used as a response element \n in the DescribeDBClusterSnapshots action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB cluster snapshot with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "AttributeValues": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

The value(s) for the manual DB cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the name and values of a manual DB cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttribute", + "traits": { + "smithy.api#xmlName": "DBClusterSnapshotAttribute" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the manual DB cluster snapshot that the attributes apply to.

" + } + }, + "DBClusterSnapshotAttributes": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributeList", + "traits": { + "smithy.api#documentation": "

The list of attributes and values for the manual DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterSnapshot", + "traits": { + "smithy.api#xmlName": "DBClusterSnapshot" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshotMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterSnapshots": { + "target": "com.amazonaws.rds#DBClusterSnapshotList", + "traits": { + "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBClusterSnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBEngineVersion": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family for the database engine.

" + } + }, + "DBEngineDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the database engine.

" + } + }, + "DBEngineVersionDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the database engine version.

" + } + }, + "DefaultCharacterSet": { + "target": "com.amazonaws.rds#CharacterSet", + "traits": { + "smithy.api#documentation": "

The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.

" + } + }, + "Image": { + "target": "com.amazonaws.rds#CustomDBEngineVersionAMI", + "traits": { + "smithy.api#documentation": "

The EC2 image

" + } + }, + "DBEngineMediaType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

" + } + }, + "SupportedCharacterSets": { + "target": "com.amazonaws.rds#SupportedCharacterSetsList", + "traits": { + "smithy.api#documentation": "

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

" + } + }, + "SupportedNcharCharacterSets": { + "target": "com.amazonaws.rds#SupportedCharacterSetsList", + "traits": { + "smithy.api#documentation": "

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

" + } + }, + "ValidUpgradeTarget": { + "target": "com.amazonaws.rds#ValidUpgradeTargetList", + "traits": { + "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" + } + }, + "SupportedTimezones": { + "target": "com.amazonaws.rds#SupportedTimezonesList", + "traits": { + "smithy.api#documentation": "

A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action.

" + } + }, + "ExportableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The types of logs that the database engine has available for export to CloudWatch Logs.

" + } + }, + "SupportsLogExportsToCloudwatchLogs": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" + } + }, + "SupportsReadReplica": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the database engine version supports read replicas.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes.

" + } + }, + "SupportedFeatureNames": { + "target": "com.amazonaws.rds#FeatureNameList", + "traits": { + "smithy.api#documentation": "

A list of features supported by the DB engine.

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB engine version, either available or deprecated.

" + } + }, + "SupportsParallelQuery": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The major engine version of the CEV.

" + } + }, + "DatabaseInstallationFilesS3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains your database installation files.

" + } + }, + "DatabaseInstallationFilesS3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files. \n If not specified, then no prefix is assumed.

" + } + }, + "DBEngineVersionArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the custom engine version.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for \n RDS Custom, but optional for Amazon RDS.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The creation time of the DB engine version.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "SupportsBabelfish": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

" + } + }, + "CustomDBEngineVersionManifest": { + "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", + "traits": { + "smithy.api#documentation": "

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). \n RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, \n and UNIX/Linux user and group using the installation parameters. For more information, \n see JSON fields in the CEV manifest in the Amazon RDS User Guide.\n

" + } + }, + "SupportsCertificateRotationWithoutRestart": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.

" + } + }, + "SupportedCACertificateIdentifiers": { + "target": "com.amazonaws.rds#CACertificateIdentifiersList", + "traits": { + "smithy.api#documentation": "

A list of the supported CA certificate identifiers.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "SupportsLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" + } + }, + "com.amazonaws.rds#DBEngineVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBEngineVersion", + "traits": { + "smithy.api#xmlName": "DBEngineVersion" + } + } + }, + "com.amazonaws.rds#DBEngineVersionMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBEngineVersions": { + "target": "com.amazonaws.rds#DBEngineVersionList", + "traits": { + "smithy.api#documentation": "

A list of DBEngineVersion elements.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBInstance": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine used for this DB instance.

" + } + }, + "DBInstanceStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" + } + }, + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when a stopped DB instance is restarted automatically.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master username for the DB instance.

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the initial database name that you provided (if required) when you created\n the DB instance. This name is returned for the life of your DB instance. For an RDS for\n Oracle CDB instance, the name identifies the PDB rather than the CDB.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#Endpoint", + "traits": { + "smithy.api#documentation": "

The connection endpoint for the DB instance.

\n \n

The endpoint might not be shown for instances with the status of creating.

\n " + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) allocated for the DB instance.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the DB instance was created.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

" + } + }, + "DBParameterGroups": { + "target": "com.amazonaws.rds#DBParameterGroupStatusList", + "traits": { + "smithy.api#documentation": "

The list of DB parameter groups applied to this DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone where the DB instance is located.

" + } + }, + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup", + "traits": { + "smithy.api#documentation": "

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#PendingModifiedValues", + "traits": { + "smithy.api#documentation": "

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

" + } + }, + "LatestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The latest time to which a database in this DB instance can be restored with point-in-time restore.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether minor version patches are applied automatically.

" + } + }, + "ReadReplicaSourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB instance if this DB instance is a read\n replica.

" + } + }, + "ReadReplicaDBInstanceIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", + "traits": { + "smithy.api#documentation": "

The identifiers of the read replicas associated with this DB\n instance.

" + } + }, + "ReadReplicaDBClusterIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", + "traits": { + "smithy.api#documentation": "

The identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

\n " + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n \n

This attribute is only supported in RDS for Oracle.

\n " + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value for the DB instance.

" + } + }, + "OptionGroupMemberships": { + "target": "com.amazonaws.rds#OptionGroupMembershipList", + "traits": { + "smithy.api#documentation": "

The list of option group memberships for this DB instance.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the character set that this instance is associated with.

" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

" + } + }, + "SecondaryAvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "StatusInfos": { + "target": "com.amazonaws.rds#DBInstanceStatusInfoList", + "traits": { + "smithy.api#documentation": "

The status of a read replica. If the DB instance isn't a read replica, the value is\n blank.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB instance.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which the instance is associated for TDE encryption.

" + } + }, + "DbInstancePort": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DB instance is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log \n entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "DomainMemberships": { + "target": "com.amazonaws.rds#DomainMembershipList", + "traits": { + "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB instance.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether tags are copied from the DB instance to snapshots of the DB instance.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

" + } + }, + "EnhancedMonitoringResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" + } + }, + "DBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB instance.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.

\n

For a list of engine versions that support IAM database authentication, see \n IAM database authentication\n in the Amazon RDS User Guide and IAM \n database authentication in Aurora in the Amazon Aurora User Guide.

" + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether Performance Insights is enabled for the DB instance.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

" + } + }, + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Monitoring Amazon RDS log files in the Amazon RDS User Guide.\n

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.

" + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.rds#DBInstanceRoles", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

" + } + }, + "ListenerEndpoint": { + "target": "com.amazonaws.rds#Endpoint", + "traits": { + "smithy.api#documentation": "

The listener connection endpoint for SQL Server Always On.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "DBInstanceAutomatedBackupsReplications": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", + "traits": { + "smithy.api#documentation": "

The list of replicated automated backups associated with the DB instance.

" + } + }, + "CustomerOwnedIpEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "ActivityStreamKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "ActivityStreamKinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "ActivityStreamMode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream. Database events such as a change or access generate \n an activity stream event. RDS for Oracle always handles these events asynchronously.

" + } + }, + "ActivityStreamEngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" + } + }, + "ResumeFullAutomationModeTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "ActivityStreamPolicyStatus": { + "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", + "traits": { + "smithy.api#documentation": "

The status of the policy state of the activity stream.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is only valid for RDS Custom DB instances.

" + } + }, + "MasterUserSecret": { + "target": "com.amazonaws.rds#MasterUserSecret", + "traits": { + "smithy.api#documentation": "

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

" + } + }, + "CertificateDetails": { + "target": "com.amazonaws.rds#CertificateDetails", + "traits": { + "smithy.api#documentation": "

The details of the DB instance's server certificate.

" + } + }, + "ReadReplicaSourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB cluster if this DB instance is a read\n replica.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The progress of the storage optimization operation as a percentage.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.

\n

This data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.

" + } + }, + "com.amazonaws.rds#DBInstanceAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB instance with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackup": { + "type": "structure", + "members": { + "DBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the automated backups.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "Region": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "RestoreWindow": { + "target": "com.amazonaws.rds#RestoreWindow", + "traits": { + "smithy.api#documentation": "

Earliest and latest time an instance can be restored to.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides a list of status information for an automated backup:

\n
    \n
  • \n

    \n active - Automated backups for current instances.

    \n
    • \n
  • \n

    \n retained - Automated backups for deleted instances.

    \n
    • \n
  • \n

    \n creating - Automated backups that are waiting for the first automated snapshot to be available.

    \n
    • \n
" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone that the automated backup was created in. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID associated with the DB instance.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Provides the date and time that the DB instance was created.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master user name of an automated backup.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine for this automated backup.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine for the automated backup.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the automated backup.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which the automated backup is associated for TDE encryption.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the automated backup is encrypted.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type associated with the automated backup.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the automated backup. In most cases, the Timezone element is empty.\n Timezone content appears only for Microsoft SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The retention period for the automated backups.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the replicated automated backups.

" + } + }, + "DBInstanceAutomatedBackupsReplications": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", + "traits": { + "smithy.api#documentation": "

The list of replications to different Amazon Web Services Regions associated with the automated backup.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput for the automated backup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that\n existed at the time you deleted the source instance.

" + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup", + "traits": { + "smithy.api#xmlName": "DBInstanceAutomatedBackup" + } + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBInstanceAutomatedBackups": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupList", + "traits": { + "smithy.api#documentation": "

A list of DBInstanceAutomatedBackup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAutomatedBackupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

No automated backup for this DB instance was found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAutomatedBackupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB instance quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

" + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication", + "traits": { + "smithy.api#xmlName": "DBInstanceAutomatedBackupsReplication" + } + } + }, + "com.amazonaws.rds#DBInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstance", + "traits": { + "smithy.api#xmlName": "DBInstance" + } + } + }, + "com.amazonaws.rds#DBInstanceMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + }, + "DBInstances": { + "target": "com.amazonaws.rds#DBInstanceList", + "traits": { + "smithy.api#documentation": "

A list of DBInstance instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstances action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBInstanceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceRole": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.

" + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n
    \n
  • \n

    \n ACTIVE - the IAM role ARN is associated with the DB instance and can be used to\n access other Amazon Web Services services on your behalf.

    \n
    • \n
  • \n

    \n PENDING - the IAM role ARN is being associated with the DB instance.

    \n
    • \n
  • \n

    \n INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable\n to assume the IAM role in order to access other Amazon Web Services services on your behalf.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

" + } + }, + "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified RoleArn or FeatureName value is already associated with the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified RoleArn value doesn't match the specified feature for\n the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceRole", + "traits": { + "smithy.api#xmlName": "DBInstanceRole" + } + } + }, + "com.amazonaws.rds#DBInstanceStatusInfo": { + "type": "structure", + "members": { + "StatusType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

This value is currently \"read replication.\"

" + } + }, + "Normal": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

" + } + }, + "Message": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a list of status information for a DB instance.

" + } + }, + "com.amazonaws.rds#DBInstanceStatusInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceStatusInfo", + "traits": { + "smithy.api#xmlName": "DBInstanceStatusInfo" + } + } + }, + "com.amazonaws.rds#DBLogFileNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBLogFileNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n LogFileName doesn't refer to an existing DB log file.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBParameterGroup": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family that this DB parameter group is compatible with.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the customer-specified description for this DB parameter group.

" + } + }, + "DBParameterGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB parameter group.

\n

This data type is used as a response element in the DescribeDBParameterGroups action.

" + } + }, + "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB parameter group with the same name exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBParameterGroupDetails": { + "type": "structure", + "members": { + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of Parameter values.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameters action.

" + } + }, + "com.amazonaws.rds#DBParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBParameterGroup", + "traits": { + "smithy.api#xmlName": "DBParameterGroup" + } + } + }, + "com.amazonaws.rds#DBParameterGroupNameMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.

" + } + }, + "com.amazonaws.rds#DBParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBParameterGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB parameter\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBParameterGroupStatus": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + }, + "ParameterApplyStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of parameter updates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the DB parameter group.

\n

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n CreateDBInstanceReadReplica\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
" + } + }, + "com.amazonaws.rds#DBParameterGroupStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBParameterGroupStatus", + "traits": { + "smithy.api#xmlName": "DBParameterGroup" + } + } + }, + "com.amazonaws.rds#DBParameterGroupsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBParameterGroups": { + "target": "com.amazonaws.rds#DBParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of DBParameterGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBProxy": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" + } + }, + "DBProxyArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the proxy.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#DBProxyStatus", + "traits": { + "smithy.api#documentation": "

The current status of this proxy. A status of available means the\n proxy is ready to handle requests. Other values indicate that you must wait for\n the proxy to be ready, or take some action to resolve an issue.

" + } + }, + "EngineFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. This value determines which database network protocol \n the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, \n RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. \n SQLSERVER supports RDS for Microsoft SQL Server databases.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID of the DB proxy.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security groups that the proxy belongs to.

" + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the proxy.

" + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigInfoList", + "traits": { + "smithy.api#documentation": "

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance\n or Aurora DB cluster.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

\n

Default: 1800 (30 minutes)

\n

Constraints: 1 to 28,800

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the proxy was first created.

" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the proxy was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data structure representing a proxy managed by the RDS Proxy.

\n

This data type is used as a response element in the DescribeDBProxies action.

" + } + }, + "com.amazonaws.rds#DBProxyAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpoint": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB proxy endpoint. An identifier must begin with a letter and\n must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen\n or contain two consecutive hyphens.

" + } + }, + "DBProxyEndpointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB proxy endpoint.

" + } + }, + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB proxy that is associated with this DB proxy endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#DBProxyEndpointStatus", + "traits": { + "smithy.api#documentation": "

The current status of this DB proxy endpoint. A status of available means the\n endpoint is ready to handle requests. Other values indicate that you must wait for\n the endpoint to be ready, or take some action to resolve an issue.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID of the DB proxy endpoint.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security groups that the DB proxy endpoint belongs to.

" + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the DB proxy endpoint.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the DB proxy endpoint was first created.

" + } + }, + "TargetRole": { + "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.

\n

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

" + } + }, + "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyEndpoint" + } + }, + "com.amazonaws.rds#DBProxyEndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#DBProxyEndpointNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The DB proxy endpoint doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB proxy already has the maximum number of endpoints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpointStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "INCOMPATIBLE_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incompatible-network" + } + }, + "INSUFFICIENT_RESOURCE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-resource-limits" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.rds#DBProxyEndpointTargetRole": { + "type": "enum", + "members": { + "READ_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_WRITE" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + } + } + }, + "com.amazonaws.rds#DBProxyList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxy" + } + }, + "com.amazonaws.rds#DBProxyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#DBProxyNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "INCOMPATIBLE_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incompatible-network" + } + }, + "INSUFFICIENT_RESOURCE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-resource-limits" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suspended" + } + }, + "SUSPENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suspending" + } + }, + "REACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reactivating" + } + } + } + }, + "com.amazonaws.rds#DBProxyTarget": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The writer endpoint for the RDS DB instance or Aurora DB cluster.

" + } + }, + "TrackedClusterId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

" + } + }, + "RdsResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier representing the target. It can be the instance identifier for an RDS DB instance,\n or the cluster identifier for an Aurora DB cluster.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

" + } + }, + "Type": { + "target": "com.amazonaws.rds#TargetType", + "traits": { + "smithy.api#documentation": "

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

" + } + }, + "Role": { + "target": "com.amazonaws.rds#TargetRole", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

" + } + }, + "TargetHealth": { + "target": "com.amazonaws.rds#TargetHealth", + "traits": { + "smithy.api#documentation": "

Information about the connection health of the RDS Proxy target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

\n

This data type is used as a response element in the DescribeDBProxyTargets action.

" + } + }, + "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetAlreadyRegisteredFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyTargetGroup": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the RDS proxy associated with this target group.

" + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" + } + }, + "TargetGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the target group.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current status of this target group. A status of available means the\n target group is correctly associated with a database. Other values indicate that you must wait for\n the target group to be ready, or take some action to resolve an issue.

" + } + }, + "ConnectionPoolConfig": { + "target": "com.amazonaws.rds#ConnectionPoolConfigurationInfo", + "traits": { + "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the target group was first created.

" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the target group was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.

\n

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" + } + }, + "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyTargetNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSecurityGroup": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of a specific DB security group.

" + } + }, + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB security group.

" + } + }, + "DBSecurityGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the description of the DB security group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VpcId of the DB security group.

" + } + }, + "EC2SecurityGroups": { + "target": "com.amazonaws.rds#EC2SecurityGroupList", + "traits": { + "smithy.api#documentation": "

Contains a list of EC2SecurityGroup elements.

" + } + }, + "IPRanges": { + "target": "com.amazonaws.rds#IPRangeList", + "traits": { + "smithy.api#documentation": "

Contains a list of IPRange elements.

" + } + }, + "DBSecurityGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB security group.

\n

This data type is used as a response element \n in the DescribeDBSecurityGroups action.

" + } + }, + "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB security group with the name specified in\n DBSecurityGroupName already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroupMembership": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RebootDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \n
" + } + }, + "com.amazonaws.rds#DBSecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSecurityGroupMembership", + "traits": { + "smithy.api#xmlName": "DBSecurityGroup" + } + } + }, + "com.amazonaws.rds#DBSecurityGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroups", + "traits": { + "smithy.api#documentation": "

A list of DBSecurityGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBSecurityGroupNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "DBSecurityGroupName" + } + } + }, + "com.amazonaws.rds#DBSecurityGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing DB security group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSecurityGroupNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB security group isn't allowed for this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QuotaExceeded.DBSecurityGroup", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB security\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSecurityGroup", + "traits": { + "smithy.api#xmlName": "DBSecurityGroup" + } + } + }, + "com.amazonaws.rds#DBSnapshot": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the identifier for the DB snapshot.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the database engine.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of this DB snapshot.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the database engine was listening on at the time of the snapshot.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID associated with the DB snapshot.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from\n which the snapshot was taken, was created.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the master username for the DB snapshot.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the version of the database engine.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the type of the DB snapshot.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the option group name for the DB snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" + } + }, + "SourceRegion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

" + } + }, + "SourceDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type associated with DB snapshot.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the DB snapshot is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DBSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB snapshot.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance when the DB snapshot was created.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "OriginalSnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

" + } + }, + "SnapshotDatabaseTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

\n

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.

" + } + }, + "SnapshotTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput for the DB snapshot.

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. The Oracle SID is also the name of your CDB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB snapshot.

\n

This data type is used as a response element \n in the DescribeDBSnapshots action.

" + } + }, + "com.amazonaws.rds#DBSnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSnapshotAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" + } + }, + "AttributeValues": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" + } + }, + "com.amazonaws.rds#DBSnapshotAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSnapshotAttribute", + "traits": { + "smithy.api#xmlName": "DBSnapshotAttribute" + } + } + }, + "com.amazonaws.rds#DBSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the manual DB snapshot that the attributes apply to.

" + } + }, + "DBSnapshotAttributes": { + "target": "com.amazonaws.rds#DBSnapshotAttributeList", + "traits": { + "smithy.api#documentation": "

The list of attributes and values for the manual DB snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSnapshot", + "traits": { + "smithy.api#xmlName": "DBSnapshot" + } + } + }, + "com.amazonaws.rds#DBSnapshotMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSnapshots": { + "target": "com.amazonaws.rds#DBSnapshotList", + "traits": { + "smithy.api#documentation": "

A list of DBSnapshot instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSnapshots action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBSnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSubnetGroup": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group.

" + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the description of the DB subnet group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VpcId of the DB subnet group.

" + } + }, + "SubnetGroupStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the status of the DB subnet group.

" + } + }, + "Subnets": { + "target": "com.amazonaws.rds#SubnetList", + "traits": { + "smithy.api#documentation": "

Contains a list of Subnet elements.

" + } + }, + "DBSubnetGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The network type of the DB subnet group.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB subnet group.

\n

This data type is used as a response element \n in the DescribeDBSubnetGroups action.

" + } + }, + "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupDoesNotCoverEnoughAZs", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSubnetGroups": { + "target": "com.amazonaws.rds#DBSubnetGroups", + "traits": { + "smithy.api#documentation": "

A list of DBSubnetGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DBSubnetGroupNotAllowedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotAllowedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DBSubnetGroup shouldn't be specified while creating read replicas that lie\n in the same region as the source instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing DB subnet group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB subnet\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSubnetGroup", + "traits": { + "smithy.api#xmlName": "DBSubnetGroup" + } + } + }, + "com.amazonaws.rds#DBSubnetQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of subnets in a\n DB subnet groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBUpgradeDependencyFailureFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBUpgradeDependencyFailure", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB upgrade failed because a resource the DB depends on can't be\n modified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DatabaseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a blue/green deployment.

\n

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

" + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the blue/green deployment to delete. This parameter isn't\n case-sensitive.

\n

Constraints:\n

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "DeleteTarget": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to delete the resources in the green environment. You can't specify\n this option if the blue/green deployment status is\n SWITCHOVER_COMPLETED.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

\n
    \n
  • \n

    The CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.

    \n
    • \n
  • \n

    The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.

    \n
    • \n
\n

Typically, deletion takes a few minutes.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.

\n \n

For more information, see Deleting a\n CEV in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "

The database engine. The only supported engines are custom-oracle-ee and custom-oracle-ee-cdb.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#documentation": "

The custom engine version (CEV) for your DB instance. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

\n

If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are\n terminated and read replicas are promoted to standalone instances.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster", + "documentation": "The following example deletes the DB cluster named mycluster and takes a final snapshot named mycluster-final-snapshot. The status of the DB cluster is available while the snapshot is being taken. ", "input": { - "target": "com.amazonaws.rds#RestoreDBClusterFromS3Message" + "DBClusterIdentifier": "mycluster", + "SkipFinalSnapshot": false, + "FinalDBSnapshotIdentifier": "mycluster-final-snapshot" }, "output": { - "target": "com.amazonaws.rds#RestoreDBClusterFromS3Result" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidS3BucketFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

\n ", - "smithy.api#examples": [ - { - "title": "To restore an Amazon Aurora DB cluster from Amazon S3", - "documentation": "The following example restores an Amazon Aurora MySQL version 5.7-compatible DB cluster from a MySQL 5.7 DB backup file in Amazon S3.", - "input": { - "DBClusterIdentifier": "cluster-s3-restore", - "Engine": "aurora-mysql", - "MasterUsername": "admin", - "MasterUserPassword": "mypassword", - "SourceEngine": "mysql", - "SourceEngineVersion": "5.7.28", - "S3BucketName": "mybucket", - "S3Prefix": "test-backup", - "S3IngestionRoleArn": "arn:aws:iam::123456789012:role/service-role/TestBackup" - }, - "output": { - "DBCluster": { - "AllocatedStorage": 1, - "AvailabilityZones": [ - "us-west-2c", - "us-west-2a", - "us-west-2b" - ], - "BackupRetentionPeriod": 1, - "DBClusterIdentifier": "cluster-s3-restore", - "DBClusterParameterGroup": "default.aurora-mysql5.7", - "DBSubnetGroup": "default", - "Status": "creating", - "Endpoint": "cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com", - "ReaderEndpoint": "cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com", - "MultiAZ": false, - "Engine": "aurora-mysql", - "EngineVersion": "5.7.12", - "Port": 3306, - "MasterUsername": "admin", - "PreferredBackupWindow": "11:15-11:45", - "PreferredMaintenanceWindow": "thu:12:19-thu:12:49", - "ReadReplicaIdentifiers": [], - "DBClusterMembers": [], - "VpcSecurityGroups": [ - { - "VpcSecurityGroupId": "sg-########", - "Status": "active" - } - ], - "HostedZoneId": "Z1PVIF0EXAMPLE", - "StorageEncrypted": false, - "DbClusterResourceId": "cluster-SU5THYQQHOWCXZZDGXREXAMPLE", - "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore", - "AssociatedRoles": [], - "IAMDatabaseAuthenticationEnabled": false, - "ClusterCreateTime": "2020-07-27T14:22:08.095Z", - "EngineMode": "provisioned", - "DeletionProtection": false, - "HttpEndpointEnabled": false, - "CopyTagsToSnapshot": false, - "CrossAccountClone": false, - "DomainMemberships": [] - } - } - } - ] - } - }, - "com.amazonaws.rds#RestoreDBClusterFromS3Message": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \n
" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database name for the restored DB cluster.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the restored DB cluster.

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with the restored DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora-mysql (for Aurora MySQL)

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Examples: 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0\n

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the instances in the restored DB cluster accept connections.

\n

Default: 3306\n

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the master user for the restored DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

\n

Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the restored DB cluster is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

" - } - }, - "SourceEngine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.

\n

Valid values: mysql\n

", - "smithy.api#required": {} - } - }, - "SourceEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.5, 5.6, and 5.7 are supported.

\n

Example: 5.6.40, 5.7.28\n

", - "smithy.api#required": {} - } - }, - "S3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

", - "smithy.api#required": {} - } - }, - "S3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.\n If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is\n created by using all of the files in the Amazon S3 bucket.

" - } - }, - "S3IngestionRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

", - "smithy.api#required": {} - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid values: aurora, aurora-iopt1\n

\n

Default: aurora\n

\n

Valid for: Aurora DB clusters only

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#RestoreDBClusterFromS3Result": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#RestoreDBClusterFromSnapshot": { - "type": "operation", + "DBCluster": { + "AllocatedStorage": 20, + "AvailabilityZones": ["eu-central-1b", "eu-central-1c", "eu-central-1a"], + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "mycluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default-vpc-aa11bb22", + "Status": "available" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon \n Resource Name (ARN) of the automated backups.

" + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackupMessage": { + "type": "structure", + "members": { + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterAutomatedBackupResult": { + "type": "structure", + "members": { + "DBClusterAutomatedBackup": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a custom DB cluster endpoint", + "documentation": "The following example deletes the specified custom DB cluster endpoint.", "input": { - "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage" + "DBClusterEndpointIdentifier": "mycustomendpoint" }, "output": { - "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" - }, - { - "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidRestoreFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", - "smithy.api#examples": [ - { - "title": "To restore a DB cluster from a snapshot", - "documentation": "The following example restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named test-instance-snapshot.", - "input": { - "DBClusterIdentifier": "newdbcluster", - "SnapshotIdentifier": "test-instance-snapshot", - "Engine": "aurora-postgresql", - "EngineVersion": "10.7" - }, - "output": { - "DBCluster": { - "AllocatedStorage": 1, - "AvailabilityZones": [ - "us-west-2c", - "us-west-2a", - "us-west-2b" - ], - "BackupRetentionPeriod": 7, - "DatabaseName": "", - "DBClusterIdentifier": "newdbcluster", - "DBClusterParameterGroup": "default.aurora-postgresql10", - "DBSubnetGroup": "default", - "Status": "creating", - "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com", - "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com", - "MultiAZ": false, - "Engine": "aurora-postgresql", - "EngineVersion": "10.7", - "Port": 5432, - "MasterUsername": "postgres", - "PreferredBackupWindow": "09:33-10:03", - "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", - "ReadReplicaIdentifiers": [], - "DBClusterMembers": [], - "VpcSecurityGroups": [ - { - "VpcSecurityGroupId": "sg-########", - "Status": "active" - } - ], - "HostedZoneId": "Z1PVIF0EXAMPLE", - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", - "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE", - "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster", - "AssociatedRoles": [], - "IAMDatabaseAuthenticationEnabled": false, - "ClusterCreateTime": "2020-06-05T15:06:58.634Z", - "EngineMode": "provisioned", - "DeletionProtection": false, - "HttpEndpointEnabled": false, - "CopyTagsToSnapshot": false, - "CrossAccountClone": false, - "DomainMemberships": [] - } - } - } - ] + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "deleting", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": ["dbinstance1", "dbinstance2", "dbinstance3"], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing DBClusterIdentifier.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "SkipFinalSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

\n \n

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

\n " + } + }, + "FinalDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.

\n \n

Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.

\n \n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" + } + }, + "DeleteAutomatedBackups": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to remove automated backups immediately after the DB\n cluster is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB cluster is deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster parameter group", + "documentation": "The following example deletes the specified DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup" } - }, - "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "SnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Snapshot.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for the new DB cluster.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version\n for the database engine in the Amazon Web Services Region is used.

\n

To list all of the available engine versions for Aurora MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See Database \n engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

See Amazon \n Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

\n

\n MySQL\n

\n

See Amazon \n RDS for MySQL in the Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon \n RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: This value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DB subnet group.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database name for the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to use for the restored DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n
    \n
  • \n

    If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.

    \n
    • \n
  • \n

    If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
\n

Valid for: Aurora DB clusters only

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

For more information, see \n CreateDBCluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing default DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" - } - } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    You can't delete a default DB cluster parameter group.

    \n
    • \n
  • \n

    Can't be associated with any DB clusters.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

\n \n

The DB cluster snapshot must be in the available state to be\n deleted.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a DB cluster snapshot", + "documentation": "", + "input": { + "DBClusterSnapshotIdentifier": "mydbclustersnapshot" + }, + "output": { + "DBClusterSnapshot": { + "AvailabilityZones": ["us-east-1a", "us-east-1b", "us-east-1e"], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to delete.

\n

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

\n

If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n
    \n
  • \n

    The DB cluster is a read replica of another Amazon Aurora DB cluster.

    \n
    • \n
  • \n

    The DB instance is the only instance in the DB cluster.

    \n
    • \n
\n

To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

", + "smithy.api#examples": [ + { + "title": "To delete a DB instance", + "documentation": "The following example deletes the specified DB instance after creating a final DB snapshot named test-instance-final-snap.", + "input": { + "DBInstanceIdentifier": "test-instance", + "SkipFinalSnapshot": false, + "FinalDBSnapshotIdentifier": "test-instance-final-snap" }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} + "output": { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "deleting" + } } - }, - "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

", + "smithy.api#examples": [ + { + "title": "To delete a replicated automated backup from a Region", + "documentation": "The following example deletes the automated backup with the specified Amazon Resource Name (ARN).", + "input": { + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" }, - "traits": { - "smithy.api#output": {} + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": {}, + "AllocatedStorage": 20, + "Status": "deleting", + "Port": 1521, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-########", + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 7, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage": { + "type": "structure", + "members": { + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DB instance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "SkipFinalSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n \n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" + } + }, + "FinalDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.

\n \n

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

\n \n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
  • \n

    Can't be specified when deleting a read replica.

    \n
    • \n
" + } + }, + "DeleteAutomatedBackups": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBParameterGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

", + "smithy.api#examples": [ + { + "title": "To delete a DB parameter group", + "documentation": "The following example deletes a DB parameter group.", + "input": { + "DBParameterGroupName": "mydbparametergroup" } - }, - "com.amazonaws.rds#RestoreDBClusterToPointInTime": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.rds#DeleteDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must be the name of an existing DB parameter group

    \n
    • \n
  • \n

    You can't delete a default DB parameter group

    \n
    • \n
  • \n

    Can't be associated with any DB instances

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing DB proxy.

" + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the\n endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write\n or read-only operations, or using a different VPC than the DB proxy's default VPC.

" + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy endpoint to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The data structure representing the details of the DB proxy endpoint that you delete.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The data structure representing the details of the DB proxy that you delete.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSecurityGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB security group.

\n

The specified DB security group must not be associated with any DB instances.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a DB security group", + "documentation": "The following example deletes a DB security group.", + "input": { + "DBSecurityGroupName": "mysecgroup" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to delete.

\n \n

You can't delete the default DB security group.

\n \n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
  • \n

    Must not be \"Default\"

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

\n \n

The DB snapshot must be in the available state to be deleted.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a DB snapshot", + "documentation": "The following example deletes the specified DB snapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "SnapshotCreateTime": "2019-06-18T22:08:40.702Z", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "deleted", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB snapshot identifier.

\n

Constraints: Must be the name of an existing DB snapshot in the available state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSubnetGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB subnet group.

\n \n

The specified database subnet group must not be associated with any DB instances.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a DB subnet group", + "documentation": "The following example deletes the DB subnet group called mysubnetgroup.", + "input": { + "DBSubnetGroupName": "mysubnetgroup" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database subnet group to delete.

\n \n

You can't delete the default subnet group.

\n \n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidEventSubscriptionStateFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an RDS event notification subscription.

", + "smithy.api#examples": [ + { + "title": "To delete an event subscription", + "documentation": "The following example deletes the specified event subscription.", "input": { - "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage" + "SubscriptionName": "my-instance-events" }, "output": { - "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult" + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "CustomerAwsId": "123456789012", + "Enabled": false, + "SourceIdsList": ["test-instance"], + "SourceType": "db-instance", + "EventCategoriesList": ["backup", "recovery"], + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "deleting" + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a global DB cluster", + "documentation": "The following example deletes an Aurora MySQL-compatible global DB cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster" }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" - }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#DeleteGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier of the global database cluster being deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeleteGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DeleteOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteOptionGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing option group.

", + "smithy.api#examples": [ + { + "title": "To delete an option group", + "documentation": "The following example deletes the specified option group.", + "input": { + "OptionGroupName": "myoptiongroup" + } + } + ] + } + }, + "com.amazonaws.rds#DeleteOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be deleted.

\n \n

You can't delete default option groups.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeregisterDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeregisterDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" + } + }, + "DBInstanceIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB instance identifiers.

" + } + }, + "DBClusterIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB cluster identifiers.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargetsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeAccountAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeAccountAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#AccountAttributesMessage" + }, + "traits": { + "smithy.api#documentation": "

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

\n

This command doesn't take any parameters.

", + "smithy.api#examples": [ + { + "title": "To describe account attributes", + "documentation": "The following example retrieves the attributes for the current AWS account.", + "output": { + "AccountQuotas": [ { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + "Max": 40, + "Used": 4, + "AccountQuotaName": "DBInstances" }, { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + "Max": 40, + "Used": 0, + "AccountQuotaName": "ReservedDBInstances" }, { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "Max": 100000, + "Used": 40, + "AccountQuotaName": "AllocatedStorage" }, { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "Max": 25, + "Used": 0, + "AccountQuotaName": "DBSecurityGroups" }, { - "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + "Max": 20, + "Used": 0, + "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" }, { - "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBParameterGroups" }, { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + "Max": 100, + "Used": 3, + "AccountQuotaName": "ManualSnapshots" }, { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + "Max": 20, + "Used": 0, + "AccountQuotaName": "EventSubscriptions" }, { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBSubnetGroups" }, { - "target": "com.amazonaws.rds#InvalidRestoreFault" + "Max": 20, + "Used": 1, + "AccountQuotaName": "OptionGroups" }, { - "target": "com.amazonaws.rds#InvalidSubnet" + "Max": 20, + "Used": 6, + "AccountQuotaName": "SubnetsPerDBSubnetGroup" }, { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "Max": 5, + "Used": 0, + "AccountQuotaName": "ReadReplicasPerMaster" }, { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "Max": 40, + "Used": 1, + "AccountQuotaName": "DBClusters" }, { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "Max": 50, + "Used": 0, + "AccountQuotaName": "DBClusterParameterGroups" }, { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", - "smithy.api#examples": [ - { - "title": "To restore a DB cluster to a specified time", - "documentation": "The following example restores the DB cluster named database-4 to the latest possible time. Using copy-on-write as the restore type restores the new DB cluster as a clone of the source DB cluster.", - "input": { - "DBClusterIdentifier": "sample-cluster-clone", - "RestoreType": "copy-on-write", - "SourceDBClusterIdentifier": "database-4", - "UseLatestRestorableTime": true - }, - "output": { - "DBCluster": { - "AllocatedStorage": 1, - "AvailabilityZones": [ - "us-west-2c", - "us-west-2a", - "us-west-2b" - ], - "BackupRetentionPeriod": 7, - "DatabaseName": "", - "DBClusterIdentifier": "sample-cluster-clone", - "DBClusterParameterGroup": "default.aurora-postgresql10", - "DBSubnetGroup": "default", - "Status": "creating", - "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com", - "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com", - "MultiAZ": false, - "Engine": "aurora-postgresql", - "EngineVersion": "10.7", - "Port": 5432, - "MasterUsername": "postgres", - "PreferredBackupWindow": "09:33-10:03", - "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", - "ReadReplicaIdentifiers": [], - "DBClusterMembers": [], - "VpcSecurityGroups": [ - { - "VpcSecurityGroupId": "sg-########", - "Status": "active" - } - ], - "HostedZoneId": "Z1PVIF0EXAMPLE", - "StorageEncrypted": true, - "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", - "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE", - "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone", - "AssociatedRoles": [], - "IAMDatabaseAuthenticationEnabled": false, - "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd", - "ClusterCreateTime": "2020-03-10T19:57:38.967Z", - "EngineMode": "provisioned", - "DeletionProtection": false, - "HttpEndpointEnabled": false, - "CopyTagsToSnapshot": false, - "CrossAccountClone": false - } - } - } - ] - } - }, - "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the new DB cluster to be created.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "RestoreType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n
    \n
  • \n

    \n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.

    \n
    • \n
  • \n

    \n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.

    \n
    • \n
\n

If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "SourceDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "RestoreToTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time to restore the DB cluster to.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n
    \n
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Must be specified if UseLatestRestorableTime parameter isn't provided

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \n
  • \n

    Can't be specified if the RestoreType parameter is copy-on-write\n

    \n
    • \n
\n

Example: 2015-03-07T23:45:00Z\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: A value from 1150-65535.

\n

Default: The default port for the engine.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group for the new DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n
    \n
  • \n

    If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

    \n
    • \n
  • \n

    If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

    \n
    • \n
\n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
\n

Valid for: Aurora MySQL DB clusters only

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" - } - }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" - } - }, - "SourceDbClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The resource ID of the source DB cluster from which to restore.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" + "Max": 5, + "Used": 0, + "AccountQuotaName": "DBClusterRoles" } - }, - "traits": { - "smithy.api#output": {} + ] } - }, - "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.rds#DescribeAccountAttributesMessage": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes one or more blue/green deployments.

\n

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

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "BlueGreenDeployments", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The blue/green deployment identifier. If you specify this parameter, the response only\n includes information about the specific blue/green deployment. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more blue/green deployments to describe.

\n

Valid Values:

\n
    \n
  • \n

    \n blue-green-deployment-identifier - Accepts system-generated\n identifiers for blue/green deployments. The results list only includes\n information about the blue/green deployments with the specified\n identifiers.

    \n
    • \n
  • \n

    \n blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. \n The results list only includes information about the blue/green deployments with the \n specified names.

    \n
    • \n
  • \n

    \n source - Accepts source databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified source databases.

    \n
    • \n
  • \n

    \n target - Accepts target databases for a blue/green deployment. \n The results list only includes information about the blue/green deployments with \n the specified target databases.

    \n
    • \n
" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeBlueGreenDeployments request. If you specify this parameter,\n the response only includes records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints:

\n
    \n
  • \n

    Must be a minimum of 20.

    \n
    • \n
  • \n

    Can't exceed 100.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse": { + "type": "structure", + "members": { + "BlueGreenDeployments": { + "target": "com.amazonaws.rds#BlueGreenDeploymentList", + "traits": { + "smithy.api#documentation": "

A list of blue/green deployments in the current account and Amazon Web Services Region.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later\n DescribeBlueGreenDeployments request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeCertificatesMessage" + }, + "output": { + "target": "com.amazonaws.rds#CertificateMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Certificates", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeCertificatesMessage": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing CertificateIdentifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterAutomatedBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Displays backups for both current and deleted DB clusters. For example, use this operation to find details \n about automated backups for previously deleted clusters. Current clusters are returned for both the \n DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.

\n

All parameters are optional.

" + } + }, + "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage": { + "type": "structure", + "members": { + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must\n match the identifier of an existing DB cluster. It returns information from the\n specific DB cluster's automated backup. This parameter isn't case-sensitive.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n
    \n
  • \n

    \n status\n

    \n
      \n
    • \n

      \n retained - Automated backups for deleted clusters and after backup replication is stopped.

      \n
      • \n
    \n
    • \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster automated backups identified by these ARNs.

    \n
    • \n
  • \n

    \n db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB cluster resources identified by these ARNs.

    \n
    • \n
\n

Returns all resources by default. The status for each resource is specified in the response.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords \n value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only \n records beyond the marker, up to MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterBacktracks": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterBacktracksMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterBacktrackMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterBacktrackNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about backtracks for a DB cluster.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora MySQL DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To describe backtracks for a DB cluster", + "documentation": "The following example retrieves details about the specified DB cluster.", "input": { - "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage" + "DBClusterIdentifier": "mydbcluster" }, "output": { - "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, + "DBClusterBacktracks": [ + { + "DBClusterIdentifier": "mydbcluster", + "BacktrackIdentifier": "2f5f5294-0dd2-44c9-9f50-EXAMPLE", + "BacktrackTo": "2021-02-12T04:59:22Z", + "BacktrackedFrom": "2021-02-12T14:37:31.640Z", + "BacktrackRequestCreationTime": "2021-02-12T14:36:18.819Z", + "Status": "COMPLETED" + }, + { + "DBClusterIdentifier": "mydbcluster", + "BacktrackIdentifier": "3c7a6421-af2a-4ea3-ae95-EXAMPLE", + "BacktrackTo": "2021-02-11T22:53:46Z", + "BacktrackedFrom": "2021-02-12T00:09:27.006Z", + "BacktrackRequestCreationTime": "2021-02-12T00:07:53.487Z", + "Status": "COMPLETED" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterBacktracks", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterBacktracksMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "BacktrackIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If specified, this value is the backtrack identifier of the backtrack to be\n described.

\n

Constraints:

\n \n

Example: 123e4567-e89b-12d3-a456-426655440000\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

\n
    \n
  • \n

    \n db-cluster-backtrack-id - Accepts backtrack identifiers. The\n results list includes information about only the backtracks identified by these\n identifiers.

    \n
    • \n
  • \n

    \n db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    \n
      \n
    • \n

      \n applying\n

      \n
      • \n
    • \n

      \n completed\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n pending\n

      \n
      • \n
    \n

    The results list includes information about only the backtracks identified\n by these values.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterEndpointsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpointMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about endpoints for an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To describe DB cluster endpoints", + "documentation": "The following example retrieves details for your DB cluster endpoints. The most common kinds of Aurora clusters have two endpoints. One endpoint has type WRITER. You can use this endpoint for all SQL statements. The other endpoint has type READER. You can use this endpoint only for SELECT and other read-only SQL statements.", + "output": { + "DBClusterEndpoints": [ { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "WRITER" }, { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "READER" }, { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "WRITER" }, { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "READER" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterEndpoints", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterEndpointsMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" + } + }, + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To describe DB cluster parameter groups", + "documentation": "The following example retrieves details for your DB cluster parameter groups.", + "output": { + "DBClusterParameterGroups": [ { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + "DBClusterParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default cluster parameter group for aurora-mysql5.7", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" }, { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "DBClusterParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default cluster parameter group for aurora-postgresql9.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" }, { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "DBClusterParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default cluster parameter group for aurora5.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" }, { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + "DBClusterParameterGroupName": "mydbclusterpg", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" }, { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" - }, + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterParameterGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the parameters in a DB cluster parameter group", + "documentation": "The following example retrieves details about the parameters in a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterpg" + }, + "output": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": ["provisioned"] + }, + { + "ParameterName": "aurora_lab_mode", + "ParameterValue": "0", + "Description": "Enables new features in the Aurora engine.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": ["provisioned"] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterParametersMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

", + "smithy.api#examples": [ + { + "title": "To describe the attribute names and values for a DB cluster snapshot", + "documentation": "The following example retrieves details of the attribute names and values for the specified DB cluster snapshot.", + "input": { + "DBClusterSnapshotIdentifier": "myclustersnapshot" + }, + "output": { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": ["123456789012"] + } + ] + } + } + } + ] + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB cluster snapshot to describe the attributes for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterSnapshotMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB cluster snapshots. This API action supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To describe a DB cluster snapshot for a DB cluster", + "documentation": "The following example retrieves the details for the DB cluster snapshots for the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusterSnapshots": [ + { + "AvailabilityZones": ["us-east-1a", "us-east-1b", "us-east-1e"], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + }, + { + "AvailabilityZones": ["us-east-1a", "us-east-1b", "us-east-1e"], + "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "automated", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterSnapshots", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "DBClusterSnapshotAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBClusterSnapshotDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBClusterSnapshots) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBClusterSnapshotNotFoundFault" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBCluster.

    \n
    • \n
" + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBClusterSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \n
" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n
    \n
  • \n

    \n automated - Return all DB cluster snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB cluster snapshots that have been marked as public.

    \n
    • \n
\n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB cluster snapshots to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB cluster snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" + } + }, + "IncludePublic": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB cluster resource ID to describe.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClustersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

", + "smithy.api#examples": [ + { + "title": "To describe a DB cluster", + "documentation": "The following example retrieves the details of the specified DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBClusters": [ + { + "AllocatedStorage": 1, + "AvailabilityZones": ["us-east-1a", "us-east-1b", "us-east-1e"], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydbcluster", + "DBClusterIdentifier": "mydbcluster", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "available", + "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", + "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MultiAZ": true, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LatestRestorableTime": "2019-06-20T22:38:14.908Z", + "Port": 3306, + "MasterUsername": "myadmin", + "PreferredBackupWindow": "09:09-09:39", + "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "dbinstance3", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance1", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance2", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster-us-east-1b", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "HostedZoneId": "Z2R2ITUGPM61AM", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusters", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "DBClusterAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBClusterDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBClusters) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBClusterNotFoundFault" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBClustersMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DB cluster identifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported Filters:

\n
    \n
  • \n

    \n clone-group-id - Accepts clone group identifiers. \n The results list only includes information about\n the DB clusters associated with these clone groups.

    \n
    • \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about\n the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-cluster-resource-id - Accepts DB cluster resource identifiers.\n The results list will only include information about the DB clusters identified\n by these DB cluster resource identifiers.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. \n The results list only includes information about\n the DB clusters associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB clusters for these engines.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBEngineVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBEngineVersionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersionMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of the available DB engines.

", + "smithy.api#examples": [ + { + "title": "To describe the DB engine versions for the MySQL DB engine", + "documentation": "The following example displays details about each of the DB engine versions for the specified DB engine.", + "input": { + "Engine": "mysql" + }, + "output": { + "DBEngineVersions": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.33", + "DBParameterGroupFamily": "mysql5.7", + "DBEngineDescription": "MySQL Community Edition", + "DBEngineVersionDescription": "MySQL 5.7.33", + "ValidUpgradeTarget": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.34", + "Description": "MySQL 5.7.34", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + { + "Engine": "mysql", + "EngineVersion": "5.7.36", + "Description": "MySQL 5.7.36", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + } + ] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBEngineVersions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBEngineVersionsMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBParameterGroupFamily.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB engine versions to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-parameter-group-family - Accepts parameter groups family names. \n The results list only includes information about\n the DB engine versions for these parameter group families.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. \n The results list only includes information about\n the DB engine versions for these engines.

    \n
    • \n
  • \n

    \n engine-mode - Accepts DB engine modes. \n The results list only includes information about\n the DB engine versions for these engine modes. Valid \n DB engine modes are the following:

    \n
      \n
    • \n

      \n global\n

      \n
      • \n
    • \n

      \n multimaster\n

      \n
      • \n
    • \n

      \n parallelquery\n

      \n
      • \n
    • \n

      \n provisioned\n

      \n
      • \n
    • \n

      \n serverless\n

      \n
      • \n
    \n
    • \n
  • \n

    \n engine-version - Accepts engine versions. \n The results list only includes information about\n the DB engine versions for these engine versions.

    \n
    • \n
  • \n

    \n status - Accepts engine version statuses. \n The results list only includes information about\n the DB engine versions for these statuses. Valid statuses \n are the following:

    \n
      \n
    • \n

      \n available\n

      \n
      • \n
    • \n

      \n deprecated\n

      \n
      • \n
    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DefaultOnly": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

" + } + }, + "ListSupportedCharacterSets": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.

" + } + }, + "ListSupportedTimezones": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.

\n

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.

" + } + }, + "IncludeAll": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.

\n

All parameters are optional.

", + "smithy.api#examples": [ + { + "title": "To describe the automated backups for a DB instance", + "documentation": "The following example displays details about the automated backups for the specified DB instance. The details include replicated automated backups in other AWS Regions.", + "input": { + "DBInstanceIdentifier": "new-orcl-db" + }, + "output": { + "DBInstanceAutomatedBackups": [ + { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": { + "EarliestTime": "2020-12-07T21:05:20.939Z", + "LatestTime": "2020-12-07T21:05:20.939Z" + }, + "AllocatedStorage": 20, + "Status": "replicating", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 14, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBInstanceAutomatedBackups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage": { + "type": "structure", + "members": { + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the DB instance that is the source of \n the automated backup. This parameter isn't case-sensitive.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance's automated backup. This parameter isn't case-sensitive.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n
    \n
  • \n

    \n status\n

    \n
      \n
    • \n

      \n active - Automated backups for current instances.

      \n
      • \n
    • \n

      \n creating - Automated backups that are waiting for the first automated snapshot to be available.

      \n
      • \n
    • \n

      \n retained - Automated backups for deleted instances and after backup replication is stopped.

      \n
      • \n
    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance automated backups identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). \n The results list includes only information about the DB instance resources identified by these ARNs.

    \n
    • \n
\n

Returns all resources by default. The status for each resource is specified in the response.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response \n includes only records beyond the marker, up to MaxRecords.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameter input for DescribeDBInstanceAutomatedBackups.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBInstancesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBInstanceMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

\n ", + "smithy.api#examples": [ + { + "title": "To describe a DB instance", + "documentation": "The following example retrieves details about the specified DB instance.", + "input": { + "DBInstanceIdentifier": "mydbinstancecf" + }, + "output": { + "DBInstances": [ + { + "DBInstanceIdentifier": "mydbinstancecf", + "DBInstanceClass": "db.t3.small", + "Engine": "mysql", + "DBInstanceStatus": "available", + "MasterUsername": "admin", + "Endpoint": { + "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z2R2ITUGPM61AM" + } + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBInstances", + "pageSize": "MaxRecords" + }, + "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], + "smithy.waiters#waitable": { + "DBInstanceAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBInstanceDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBInstances) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBInstanceNotFound" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBInstancesMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DB instance.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported Filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes information about \n the DB instances associated with the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs). The results list only includes information about\n the DB instances identified by these ARNs.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts DB instance resource identifiers. The results list \n only includes information about the DB instances identified by these DB instance resource identifiers.

    \n
    • \n
  • \n

    \n domain - Accepts Active Directory directory IDs. The results list only includes \n information about the DB instances associated with these domains.

    \n
    • \n
  • \n

    \n engine - Accepts engine names. The results list only includes information \n about the DB instances for these engines.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBLogFiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBLogFilesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBLogFilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB log files for the DB instance.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To describe the log files for a DB instance", + "documentation": "The following example retrieves details about the log files for the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DescribeDBLogFiles": [ { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + "Size": 0, + "LastWritten": 1533060000000, + "LogFileName": "error/mysql-error-running.log" }, { - "target": "com.amazonaws.rds#InvalidRestoreFault" + "Size": 2683, + "LastWritten": 1532994300000, + "LogFileName": "error/mysql-error-running.log.0" }, { - "target": "com.amazonaws.rds#InvalidSubnet" + "Size": 107, + "LastWritten": 1533057300000, + "LogFileName": "error/mysql-error-running.log.18" }, { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "Size": 13105, + "LastWritten": 1532991000000, + "LogFileName": "error/mysql-error-running.log.23" }, { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "Size": 0, + "LastWritten": 1533061200000, + "LogFileName": "error/mysql-error.log" }, { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" - }, + "Size": 3519, + "LastWritten": 1532989252000, + "LogFileName": "mysqlUpgrade" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DescribeDBLogFiles", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBLogFilesDetails": { + "type": "structure", + "members": { + "LogFileName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the log file for the specified DB instance.

" + } + }, + "LastWritten": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A POSIX timestamp when the last log entry was written.

" + } + }, + "Size": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size, in bytes, of the log file for the specified DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element to DescribeDBLogFiles.

" + } + }, + "com.amazonaws.rds#DescribeDBLogFilesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DescribeDBLogFilesDetails", + "traits": { + "smithy.api#xmlName": "DescribeDBLogFilesDetails" + } + } + }, + "com.amazonaws.rds#DescribeDBLogFilesMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "FilenameContains": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Filters the available log files for log file names that contain the specified string.

" + } + }, + "FileLastWritten": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

" + } + }, + "FileSize": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Filters the available log files for files larger than the specified size.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBLogFilesResponse": { + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "target": "com.amazonaws.rds#DescribeDBLogFilesList", + "traits": { + "smithy.api#documentation": "

The DB log files returned.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBLogFiles request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response from a call to DescribeDBLogFiles.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBParameterGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.

", + "smithy.api#examples": [ + { + "title": "To describe your DB parameter groups", + "documentation": "The following example retrieves details about your DB parameter groups.", + "output": { + "DBParameterGroups": [ { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "DBParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default parameter group for aurora-mysql5.7", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7" }, { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + "DBParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default parameter group for aurora-postgresql9.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6" }, { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" + "DBParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default parameter group for aurora5.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6" }, { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + "DBParameterGroupName": "default.mariadb10.1", + "DBParameterGroupFamily": "mariadb10.1", + "Description": "Default parameter group for mariadb10.1", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1" } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n ", - "smithy.api#examples": [ - { - "title": "To restore a DB instance from a DB snapshot", - "documentation": "The following example creates a new DB instance named db7-new-instance with the db.t3.small DB instance class from the specified DB snapshot. The source DB instance from which the snapshot was taken uses a deprecated DB instance class, so you can't upgrade it.", - "input": { - "DBInstanceIdentifier": "db7-new-instance", - "DBSnapshotIdentifier": "db7-test-snapshot", - "DBInstanceClass": "db.t3.small" - }, - "output": { - "DBInstance": { - "DBInstanceIdentifier": "db7-new-instance", - "DBInstanceClass": "db.t3.small", - "Engine": "mysql", - "DBInstanceStatus": "creating", - "PreferredMaintenanceWindow": "mon:07:37-mon:08:07", - "PendingModifiedValues": {}, - "MultiAZ": false, - "EngineVersion": "5.7.22", - "AutoMinorVersionUpgrade": true, - "ReadReplicaDBInstanceIdentifiers": [], - "LicenseModel": "general-public-license", - "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance", - "IAMDatabaseAuthenticationEnabled": false, - "PerformanceInsightsEnabled": false, - "DeletionProtection": false, - "AssociatedRoles": [] - } - } - } - ] + ] } - }, - "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 numbers, letters, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

", - "smithy.api#required": {} - } - }, - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \n

    Can't be specified when DBClusterSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBClusterSnapshotIdentifier isn't specified.

    \n
    • \n
  • \n

    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

    \n
    • \n
" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Default: The same port as the original DB instance

\n

Constraints: Value must be 1150-65535\n

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" - } - }, - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

\n

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

\n

Constraints: Must be an integer greater than 1000.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DomainFqdn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" - } - }, - "DomainOu": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" - } - }, - "DomainAuthSecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Constraints:

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" - } - }, - "DomainDnsIps": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Multi-AZ DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be specified when DBSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBSnapshotIdentifier isn't specified.

    \n
    • \n
  • \n

    If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier\n must be the ARN of the shared snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an Aurora DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

    \n
    • \n
" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.

\n " - } - } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBParameterGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBParameterGroupsMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB parameter group.

", + "smithy.api#examples": [ + { + "title": "To describe the parameters in a DB parameter group", + "documentation": "The following example retrieves the details of the specified DB parameter group.", + "input": { + "DBParameterGroupName": "mydbpg" + }, + "output": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + }, + { + "ParameterName": "auto_generate_certs", + "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The parameter types to return.

\n

Default: All parameter types returned

\n

Valid Values: user | system | engine-default\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxies": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxiesRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxies.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBProxies", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxiesRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your Amazon Web Services account ID.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxiesResponse": { + "type": "structure", + "members": { + "DBProxies": { + "target": "com.amazonaws.rds#DBProxyList", + "traits": { + "smithy.api#documentation": "

A return value representing an arbitrary number of DBProxy data structures.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxy endpoints.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBProxyEndpoints", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpointsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#DBProxyName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy whose endpoints you want to describe. If you omit\n this parameter, the output includes information about all DB proxy endpoints\n associated with all your DB proxies.

" + } + }, + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of a DB proxy endpoint to describe. If you omit this parameter,\n the output includes information about all DB proxy endpoints associated with\n the specified proxy.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpointsResponse": { + "type": "structure", + "members": { + "DBProxyEndpoints": { + "target": "com.amazonaws.rds#DBProxyEndpointList", + "traits": { + "smithy.api#documentation": "

The list of ProxyEndpoint objects returned by the API operation.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "TargetGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxy associated with the target group.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse": { + "type": "structure", + "members": { + "TargetGroups": { + "target": "com.amazonaws.rds#TargetGroupList", + "traits": { + "smithy.api#documentation": "

An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DBProxyTarget objects. This API supports pagination.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Targets", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTarget to describe.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetsResponse": { + "type": "structure", + "members": { + "Targets": { + "target": "com.amazonaws.rds#TargetList", + "traits": { + "smithy.api#documentation": "

An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSecurityGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSecurityGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To list DB security group settings", + "documentation": "This example lists settings for the specified security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup" + }, + "output": {} + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSecurityGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBSecurityGroupsMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to return details for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

", + "smithy.api#examples": [ + { + "title": "To describe the attribute names and values for a DB snapshot", + "documentation": "The following example describes the attribute names and values for a DB snapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} + "output": { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": ["123456789012", "210987654321"] + } + ] + } } - }, - "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } + } + ] + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot to describe the attributes for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBSnapshotAttributesResult" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeDBSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSnapshotsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSnapshotMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB snapshots. This API action supports pagination.

", + "smithy.api#examples": [ + { + "title": "To describe a DB snapshot for a DB instance", + "documentation": "The following example retrieves the details of a DB snapshot for a DB instance.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + "DBSnapshots": [ + { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "mysqldb", + "SnapshotCreateTime": "2018-02-08T22:28:08.598Z", + "Engine": "mysql", + "AllocatedStorage": 20, + "Status": "available", + "Port": 3306, + "AvailabilityZone": "us-east-1f", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2018-02-08T22:24:55.973Z", + "MasterUsername": "mysqladmin", + "EngineVersion": "5.6.37", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSnapshots", + "pageSize": "MaxRecords" + }, + "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], + "smithy.waiters#waitable": { + "DBSnapshotAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBSnapshotDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBSnapshots) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBSnapshotNotFound" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBSnapshotsMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBInstance.

    \n
    • \n
" + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB snapshot identifier to describe.\n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \n

    If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    \n
    • \n
" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n
    \n
  • \n

    \n automated - Return all DB snapshots that have been automatically taken by \n Amazon RDS for my Amazon Web Services account.

    \n
    • \n
  • \n

    \n manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

    \n
    • \n
  • \n

    \n shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

    \n
    • \n
  • \n

    \n public - Return all DB snapshots that have been marked as public.

    \n
    • \n
  • \n

    \n awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

    \n

    For information about Amazon Web Services Backup, see the \n \n Amazon Web Services Backup Developer Guide.\n \n

    \n

    The awsbackup type does not apply to Aurora.

    \n
    • \n
\n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB snapshots to describe.

\n

Supported filters:

\n
    \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance Amazon Resource Names (ARNs).

    \n
    • \n
  • \n

    \n db-snapshot-id - Accepts DB snapshot identifiers.

    \n
    • \n
  • \n

    \n dbi-resource-id - Accepts identifiers of source DB instances.

    \n
    • \n
  • \n

    \n snapshot-type - Accepts types of DB snapshots.

    \n
    • \n
  • \n

    \n engine - Accepts names of database engines.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "IncludePublic": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB resource ID to describe.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeDBSubnetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSubnetGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSubnetGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

", + "smithy.api#examples": [ + { + "title": "To describe a DB subnet group", + "documentation": "The following example retrieves the details of the specified DB subnet group.", + "output": { + "DBSubnetGroups": [ + { + "DBSubnetGroupName": "mydbsubnetgroup", + "DBSubnetGroupDescription": "My DB Subnet Group", + "VpcId": "vpc-971c12ee", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-d8c8e7f4", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-718fdc7d", + "SubnetAvailabilityZone": { + "Name": "us-east-1f" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-cbc8e7e7", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0ccde220", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSubnetGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBSubnetGroupsMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group to return details for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the default engine and system parameter information for the cluster database engine.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the default engine and system parameter information for the Aurora database engine", + "documentation": "The following example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility.", + "input": { + "DBParameterGroupFamily": "aurora-mysql5.7" }, - "traits": { - "smithy.api#output": {} + "output": { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "aurora_load_from_s3_role", + "Description": "IAM role ARN used to load data from AWS S3", + "Source": "engine-default", + "ApplyType": "dynamic", + "DataType": "string", + "IsModifiable": true, + "SupportedEngineModes": ["provisioned"] + } + ] + } } - }, - "com.amazonaws.rds#RestoreDBInstanceFromS3": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group family to return engine parameter information for.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult": { + "type": "structure", + "members": { + "EngineDefaults": { + "target": "com.amazonaws.rds#EngineDefaults" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEngineDefaultParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeEngineDefaultParametersResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the default engine and system parameter information for the specified database engine.

", + "smithy.api#examples": [ + { + "title": "To describe the default engine and system parameter information for the database engine", + "documentation": "The following example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.", "input": { - "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Message" + "DBParameterGroupFamily": "mysql5.7" }, "output": { - "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Result" + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false + } + ] + } + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "EngineDefaults.Marker", + "items": "EngineDefaults.Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql5.7\n

    \n
    • \n
  • \n

    \n aurora-mysql8.0\n

    \n
    • \n
  • \n

    \n aurora-postgresql10\n

    \n
    • \n
  • \n

    \n aurora-postgresql11\n

    \n
    • \n
  • \n

    \n aurora-postgresql12\n

    \n
    • \n
  • \n

    \n aurora-postgresql13\n

    \n
    • \n
  • \n

    \n aurora-postgresql14\n

    \n
    • \n
  • \n

    \n custom-oracle-ee-19\n

    \n
    • \n
  • \n

    \n mariadb10.2\n

    \n
    • \n
  • \n

    \n mariadb10.3\n

    \n
    • \n
  • \n

    \n mariadb10.4\n

    \n
    • \n
  • \n

    \n mariadb10.5\n

    \n
    • \n
  • \n

    \n mariadb10.6\n

    \n
    • \n
  • \n

    \n mysql5.7\n

    \n
    • \n
  • \n

    \n mysql8.0\n

    \n
    • \n
  • \n

    \n oracle-ee-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb-21\n

    \n
    • \n
  • \n

    \n oracle-se2-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-19\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb-21\n

    \n
    • \n
  • \n

    \n postgres10\n

    \n
    • \n
  • \n

    \n postgres11\n

    \n
    • \n
  • \n

    \n postgres12\n

    \n
    • \n
  • \n

    \n postgres13\n

    \n
    • \n
  • \n

    \n postgres14\n

    \n
    • \n
  • \n

    \n sqlserver-ee-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ee-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-ex-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-se-15.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-11.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-12.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-13.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-14.0\n

    \n
    • \n
  • \n

    \n sqlserver-web-15.0\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParametersResult": { + "type": "structure", + "members": { + "EngineDefaults": { + "target": "com.amazonaws.rds#EngineDefaults" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#DescribeEventCategories": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventCategoriesMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventCategoriesMessage" + }, + "traits": { + "smithy.api#documentation": "

Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .

", + "smithy.api#examples": [ + { + "title": "To describe event categories", + "documentation": "The following example retrieves details about the event categories for all available event sources.", + "input": { + "SourceType": "", + "Filters": [] }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidS3BucketFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, + "output": { + "EventCategoriesMapList": [ { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "SourceType": "db-instance", + "EventCategories": [ + "deletion", + "read replica", + "failover", + "restoration", + "maintenance", + "low storage", + "configuration change", + "backup", + "creation", + "availability", + "recovery", + "failure", + "backtrack", + "notification" + ] }, { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" + "SourceType": "db-security-group", + "EventCategories": ["configuration change", "failure"] }, { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "SourceType": "db-parameter-group", + "EventCategories": ["configuration change"] }, { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + "SourceType": "db-snapshot", + "EventCategories": ["deletion", "creation", "restoration", "notification"] }, { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" + "SourceType": "db-cluster", + "EventCategories": ["failover", "failure", "notification"] }, { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + "SourceType": "db-cluster-snapshot", + "EventCategories": ["backup"] } - ], - "traits": { - "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

" + ] } - }, - "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { - "type": "structure", - "members": { - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

", - "smithy.api#required": {} - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.

\n " - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

", - "smithy.api#required": {} - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid Values: \n mysql\n

", - "smithy.api#required": {} - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the master user.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups to associate with this DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Type: Integer

\n

Valid Values: 1150-65535\n

\n

Default: 3306\n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model for this DB instance.\n Use general-public-license.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, \n you must also include a value for the Iops parameter.

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the new DB instance is encrypted or not.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60

\n

Default: 0\n

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" - } - }, - "SourceEngine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the engine of your source database.

\n

Valid Values: \n mysql\n

", - "smithy.api#required": {} - } - }, - "SourceEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.6 and 5.7 are supported.

\n

Example: 5.6.40\n

", - "smithy.api#required": {} - } - }, - "S3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of your Amazon S3 bucket \n that contains your database backup file.

", - "smithy.api#required": {} - } - }, - "S3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The prefix of your Amazon S3 bucket.

" - } - }, - "S3IngestionRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

", - "smithy.api#required": {} - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + ] + } + }, + "com.amazonaws.rds#DescribeEventCategoriesMessage": { + "type": "structure", + "members": { + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEventSubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventSubscriptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventSubscriptionsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

\n

If you specify a SubscriptionName, lists the description for that subscription.

", + "smithy.api#examples": [ + { + "title": "To describe event subscriptions", + "documentation": "This example describes all of the Amazon RDS event subscriptions for the current AWS account.", + "output": { + "EventSubscriptionsList": [ + { + "EventCategoriesList": ["backup", "recovery"], + "Enabled": true, + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Status": "creating", + "SourceType": "db-instance", + "CustomerAwsId": "123456789012", + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "EventSubscriptionsList", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEventSubscriptionsMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventsMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventsMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", + "smithy.api#examples": [ + { + "title": "To describe events", + "documentation": "The following retrieves details for the events that have occurred for the specified DB instance.", + "input": { + "SourceIdentifier": "test-instance", + "SourceType": "db-instance" + }, + "output": { + "Events": [ + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": ["backup"], + "Message": "Backing up DB instance", + "Date": "2018-07-31T23:09:23.983Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + }, + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": ["backup"], + "Message": "Finished DB Instance backup", + "Date": "2018-07-31T23:15:13.049Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Events", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEventsMessage": { + "type": "structure", + "members": { + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

\n

Constraints:

\n
    \n
  • \n

    If SourceIdentifier is supplied, SourceType must also be provided.

    \n
    • \n
  • \n

    If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    \n
    • \n
  • \n

    If the source type is an RDS Proxy, a DBProxyName value must be supplied.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#SourceType", + "traits": { + "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are returned.

" + } + }, + "StartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + } + }, + "EndTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories that trigger notifications for a event notification subscription.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeExportTasksMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTasksMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ExportTaskNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a snapshot or cluster export to Amazon S3. This API operation supports\n pagination.

", + "smithy.api#examples": [ + { + "title": "To describe snapshot export tasks", + "documentation": "The following example returns information about snapshot exports to Amazon S3.", + "output": { + "ExportTasks": [ + { + "ExportTaskIdentifier": "test-snapshot-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot", + "SnapshotTime": "2020-03-02T18:26:28.163Z", + "TaskStartTime": "2020-03-02T18:57:56.896Z", + "TaskEndTime": "2020-03-02T19:10:31.985Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "COMPLETE", + "PercentProgress": 100, + "TotalExtractedDataInGB": 0 + }, + { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "mybucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ExportTasks", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeExportTasksMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the snapshot or cluster export task to be described.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.

\n

Supported filters include the following:

\n
    \n
  • \n

    \n export-task-identifier - An identifier for the snapshot or cluster export task.

    \n
    • \n
  • \n

    \n s3-bucket - The Amazon S3 bucket the data is exported to.

    \n
    • \n
  • \n

    \n source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

    \n
    • \n
  • \n

    \n status - The status of the export task. Must be lowercase. Valid statuses are the following:

    \n
      \n
    • \n

      \n canceled\n

      \n
      • \n
    • \n

      \n canceling\n

      \n
      • \n
    • \n

      \n complete\n

      \n
      • \n
    • \n

      \n failed\n

      \n
      • \n
    • \n

      \n in_progress\n

      \n
      • \n
    • \n

      \n starting\n

      \n
      • \n
    \n
    • \n
" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#ExportSourceType", + "traits": { + "smithy.api#documentation": "

The type of source for the export.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeGlobalClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeGlobalClustersMessage" + }, + "output": { + "target": "com.amazonaws.rds#GlobalClustersMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about Aurora global database clusters. This API supports pagination.

\n

For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To describe global DB clusters", + "documentation": "The following example lists Aurora global DB clusters in the current AWS Region.", + "output": { + "GlobalClusters": [ + { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f5982077e3b5aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "GlobalClusters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeGlobalClustersMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DBClusterIdentifier.

    \n
    • \n
" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeOptionGroupOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOptionGroupOptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OptionGroupOptionsMessage" + }, + "traits": { + "smithy.api#documentation": "

Describes all available options.

", + "smithy.api#examples": [ + { + "title": "To describe all available options", + "documentation": "The following example lists the options for an RDS for MySQL version 8.0 DB instance.", + "input": { + "EngineName": "mysql", + "MajorEngineVersion": "8.0" + }, + "output": { + "OptionGroupOptions": [ + { + "Name": "MARIADB_AUDIT_PLUGIN", + "Description": "MariaDB Audit Plugin", + "EngineName": "mysql", + "MajorEngineVersion": "8.0", + "MinimumRequiredMinorEngineVersion": "25", + "PortRequired": false, + "OptionsDependedOn": [], + "OptionsConflictsWith": [], + "Persistent": false, + "Permanent": false, + "RequiresAutoMinorEngineVersionUpgrade": false, + "VpcOnly": false, + "OptionGroupOptionSettings": [ + { + "SettingName": "SERVER_AUDIT_INCL_USERS", + "SettingDescription": "Include specified users", + "ApplyType": "DYNAMIC", + "IsModifiable": true, + "IsRequired": false, + "MinimumEngineVersionPerAllowedValue": [] + }, + { + "SettingName": "SERVER_AUDIT_EXCL_USERS", + "SettingDescription": "Exclude specified users", + "ApplyType": "DYNAMIC", + "IsModifiable": true, + "IsRequired": false, + "MinimumEngineVersionPerAllowedValue": [] + } + ] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OptionGroupOptions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOptionGroupOptionsMessage": { + "type": "structure", + "members": { + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If specified, filters the results to include only options for the specified major engine version.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeOptionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOptionGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OptionGroups" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the available option groups.

", + "smithy.api#examples": [ + { + "title": "To describe the available option groups", + "documentation": "The following example lists the options groups for an Oracle Database 19c instance.", + "input": { + "EngineName": "oracle-ee", + "MajorEngineVersion": "19" + }, + "output": { + "OptionGroupsList": [ + { + "OptionGroupName": "default:oracle-ee-19", + "OptionGroupDescription": "Default option group for oracle-ee 19", + "EngineName": "oracle-ee", + "MajorEngineVersion": "19", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OptionGroupsList", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOptionGroupsMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeOrderableDBInstanceOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OrderableDBInstanceOptionsMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

", + "smithy.api#examples": [ + { + "title": "To describe orderable DB instance options", + "documentation": "The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.", + "input": { + "Engine": "mysql" + }, + "output": { + "OrderableDBInstanceOptions": [ + { + "Engine": "mysql", + "EngineVersion": "5.7.33", + "DBInstanceClass": "db.m4.10xlarge", + "LicenseModel": "general-public-license", + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + }, + { + "Name": "us-east-1e" + }, + { + "Name": "us-east-1f" + } + ], + "MultiAZCapable": true, + "ReadReplicaCapable": true, + "Vpc": true, + "SupportsStorageEncryption": true, + "StorageType": "gp2" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OrderableDBInstanceOptions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:

\n
    \n
  • \n

    \n aurora-mysql\n

    \n
    • \n
  • \n

    \n aurora-postgresql\n

    \n
    • \n
  • \n

    \n custom-oracle-ee\n

    \n
    • \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "Vpc": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 10000.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribePendingMaintenanceActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#PendingMaintenanceActionsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

", + "smithy.api#examples": [ + { + "title": "To list resources with at least one pending maintenance action", + "documentation": "The following example lists the pending maintenace action for a DB instance.", + "output": { + "PendingMaintenanceActions": [ + { + "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "Description": "Upgrade to Aurora PostgreSQL 2.4.2" } + ] } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#RestoreDBInstanceFromS3Result": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} + ] } - }, - "com.amazonaws.rds#RestoreDBInstanceToPointInTime": { - "type": "operation", + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "PendingMaintenanceActions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of a resource to return pending maintenance actions for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions for.

\n

Supported filters:

\n
    \n
  • \n

    \n db-cluster-id - Accepts DB cluster identifiers and DB \n cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance \n actions for the DB clusters identified by these ARNs.

    \n
    • \n
  • \n

    \n db-instance-id - Accepts DB instance identifiers and DB \n instance ARNs. The results list only includes pending maintenance \n actions for the DB instances identified by these ARNs.

    \n
    • \n
" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeReservedDBInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesMessage" + }, + "output": { + "target": "com.amazonaws.rds#ReservedDBInstanceMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

", + "smithy.api#examples": [ + { + "title": "To describe reserved DB instances", + "documentation": "The following example retrieves details about any reserved DB instances in the current AWS account.", + "output": { + "ReservedDBInstances": [ + { + "ReservedDBInstanceId": "myreservedinstance", + "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456", + "DBInstanceClass": "db.t3.micro", + "StartTime": "2020-06-01T13:44:21.436Z", + "Duration": 31536000, + "FixedPrice": 0, + "UsagePrice": 0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "sqlserver-ex(li)", + "OfferingType": "No Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.014, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance", + "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedDBInstances", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesMessage": { + "type": "structure", + "members": { + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" + } + }, + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" + } + }, + "LeaseId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage" + }, + "output": { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists available reserved DB instance offerings.

", + "smithy.api#examples": [ + { + "title": "To describe reserved DB instance offerings", + "documentation": "The following example retrieves details about reserved DB instance options for RDS for Oracle.", "input": { - "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage" + "ProductDescription": "oracle" }, "output": { - "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult" + "ReservedDBInstancesOfferings": [ + { + "CurrencyCode": "USD", + "UsagePrice": 0, + "ProductDescription": "oracle-se2(li)", + "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8", + "MultiAZ": true, + "DBInstanceClass": "db.m4.xlarge", + "OfferingType": "Partial Upfront", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.594, + "RecurringChargeFrequency": "Hourly" + } + ], + "FixedPrice": 4089, + "Duration": 31536000 + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedDBInstancesOfferings", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

\n \n

The results show offerings that partially match the filter value.

\n " + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeSourceRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeSourceRegionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#SourceRegionMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.

\n

Use this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.

\n

To return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.

", + "smithy.api#examples": [ + { + "title": "To describe source Regions", + "documentation": "The following example retrieves details about all source AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. It also shows that automated backups can be replicated only from US West (Oregon) to the destination AWS Region, US East (N. Virginia).", + "input": { + "RegionName": "us-east-1" }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" - }, + "output": { + "SourceRegions": [ { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + "RegionName": "af-south-1", + "Endpoint": "https://rds.af-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false }, { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + "RegionName": "ap-east-1", + "Endpoint": "https://rds.ap-east-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false }, { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + "RegionName": "ap-northeast-1", + "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + "RegionName": "ap-northeast-2", + "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + "RegionName": "ap-northeast-3", + "Endpoint": "https://rds.ap-northeast-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false }, { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + "RegionName": "ap-south-1", + "Endpoint": "https://rds.ap-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "RegionName": "ap-southeast-1", + "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "RegionName": "ap-southeast-2", + "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + "RegionName": "ap-southeast-3", + "Endpoint": "https://rds.ap-southeast-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false }, { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + "RegionName": "ca-central-1", + "Endpoint": "https://rds.ca-central-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + "RegionName": "eu-north-1", + "Endpoint": "https://rds.eu-north-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#InvalidRestoreFault" + "RegionName": "eu-south-1", + "Endpoint": "https://rds.eu-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false }, { - "target": "com.amazonaws.rds#InvalidSubnet" + "RegionName": "eu-west-1", + "Endpoint": "https://rds.eu-west-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "RegionName": "eu-west-2", + "Endpoint": "https://rds.eu-west-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "RegionName": "eu-west-3", + "Endpoint": "https://rds.eu-west-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" + "RegionName": "me-central-1", + "Endpoint": "https://rds.me-central-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false }, { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "RegionName": "me-south-1", + "Endpoint": "https://rds.me-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false }, { - "target": "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault" + "RegionName": "sa-east-1", + "Endpoint": "https://rds.sa-east-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + "RegionName": "us-east-2", + "Endpoint": "https://rds.us-east-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" + "RegionName": "us-west-1", + "Endpoint": "https://rds.us-west-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true }, { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + "RegionName": "us-west-2", + "Endpoint": "https://rds.us-west-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true } - ], - "traits": { - "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n ", - "smithy.api#examples": [ - { - "title": "To restore a DB instance to a point in time", - "documentation": "The following example restores test-instance to a new DB instance named restored-test-instance, as of the specified time.", - "input": { - "SourceDBInstanceIdentifier": "test-instance", - "TargetDBInstanceIdentifier": "restored-test-instance", - "RestoreTime": "2018-07-30T23:45:00.000Z" - }, - "output": { - "DBInstance": { - "PubliclyAccessible": true, - "MasterUsername": "mymasteruser", - "MonitoringInterval": 0, - "LicenseModel": "general-public-license", - "VpcSecurityGroups": [ - { - "Status": "active", - "VpcSecurityGroupId": "sg-e5e5b0d2" - } - ], - "CopyTagsToSnapshot": false, - "OptionGroupMemberships": [ - { - "Status": "in-sync", - "OptionGroupName": "default:mysql-5-6" - } - ], - "PendingModifiedValues": {}, - "Engine": "mysql", - "MultiAZ": false, - "DBSecurityGroups": [], - "DBParameterGroups": [ - { - "DBParameterGroupName": "default.mysql5.6", - "ParameterApplyStatus": "in-sync" - } - ], - "AutoMinorVersionUpgrade": true, - "PreferredBackupWindow": "12:58-13:28", - "DBSubnetGroup": { - "Subnets": [ - { - "SubnetStatus": "Active", - "SubnetIdentifier": "subnet-77e8db03", - "SubnetAvailabilityZone": { - "Name": "us-west-2a" - } - }, - { - "SubnetStatus": "Active", - "SubnetIdentifier": "subnet-c39989a1", - "SubnetAvailabilityZone": { - "Name": "us-west-2b" - } - }, - { - "SubnetStatus": "Active", - "SubnetIdentifier": "subnet-4b267b0d", - "SubnetAvailabilityZone": { - "Name": "us-west-2c" - } - } - ], - "DBSubnetGroupName": "default", - "VpcId": "vpc-c1c5b3a3", - "DBSubnetGroupDescription": "default", - "SubnetGroupStatus": "Complete" - }, - "ReadReplicaDBInstanceIdentifiers": [], - "AllocatedStorage": 200, - "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:restored-test-instance", - "BackupRetentionPeriod": 7, - "DBName": "sample", - "PreferredMaintenanceWindow": "tue:10:16-tue:10:46", - "DBInstanceStatus": "available", - "EngineVersion": "5.6.27", - "AvailabilityZone": "us-west-2b", - "DomainMemberships": [], - "StorageType": "gp2", - "DbiResourceId": "db-VNZUCCBTEDC4WR7THXNJO72HVQ", - "CACertificateIdentifier": "rds-ca-2015", - "StorageEncrypted": false, - "DBInstanceClass": "db.t2.small", - "DbInstancePort": 0, - "DBInstanceIdentifier": "restored-test-instance" - } - } - } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "SourceRegions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeSourceRegionsMessage": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source Amazon Web Services Region name. For example, us-east-1.

\n

Constraints:

\n
    \n
  • \n

    Must specify a valid Amazon Web Services Region name.

    \n
    • \n
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To describe valid modifications for a DB instance", + "documentation": "The following example retrieves details about the valid modifications for the specified DB instance.", + "input": { + "DBInstanceIdentifier": "database-test1" + }, + "output": { + "ValidDBInstanceModificationsMessage": { + "Storage": [ + { + "StorageType": "gp2", + "StorageSize": [ + { + "From": 20, + "To": 20, + "Step": 1 + }, + { + "From": 22, + "To": 6144, + "Step": 1 + } + ] + } ] + } } - }, - "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage": { - "type": "structure", - "members": { - "SourceDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the source DB instance from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB instance.

    \n
    • \n
" - } - }, - "TargetDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the new DB instance to be created.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "RestoreTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time to restore from.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n
    \n
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \n
\n

Example: 2009-09-07T23:45:00Z\n

" - } - }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.

\n

Constraints: Can't be specified if the RestoreTime parameter is provided.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: The same DBInstanceClass as the original DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" - } - }, - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database name for the restored DB instance.

\n \n

This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

\n " - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

\n

Constraints: Must be an integer greater than 1000.

\n

\n SQL Server\n

\n

Setting the IOPS value for the SQL Server database engine isn't supported.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" - } - }, - "DomainFqdn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" - } - }, - "DomainOu": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" - } - }, - "DomainAuthSecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" - } - }, - "DomainDnsIps": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "SourceDbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The resource ID of the source DB instance from which to restore.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "SourceDBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } + } + ] + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The customer identifier or the ARN of your DB instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult": { + "type": "structure", + "members": { + "ValidDBInstanceModificationsMessage": { + "target": "com.amazonaws.rds#ValidDBInstanceModificationsMessage" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#DomainMembership": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory Domain.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

" + } + }, + "FQDN": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the Active Directory Domain.

" + } + }, + "IAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role used when making API calls to the Directory Service.

" + } + }, + "OU": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for the DB instance or cluster.

" + } + }, + "AuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain.

" + } + }, + "DnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Active Directory Domain membership record associated with the DB instance or cluster.

" + } + }, + "com.amazonaws.rds#DomainMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DomainMembership", + "traits": { + "smithy.api#xmlName": "DomainMembership" + } + } + }, + "com.amazonaws.rds#DomainNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DomainNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n Domain doesn't refer to an existing Active Directory domain.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.rds#DoubleOptional": { + "type": "double" + }, + "com.amazonaws.rds#DoubleRange": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum value in the range.

" + } + }, + "To": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum value in the range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of double values.

" + } + }, + "com.amazonaws.rds#DoubleRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DoubleRange", + "traits": { + "smithy.api#xmlName": "DoubleRange" + } + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DownloadDBLogFilePortionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DownloadDBLogFilePortionDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBLogFileNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To download a DB log file", + "documentation": "The following example downloads only the latest part of your log file.", + "input": { + "DBInstanceIdentifier": "test-instance", + "LogFileName": "log.txt" + }, + "output": {} + } + ], + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "NumberOfLines" + } + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortionDetails": { + "type": "structure", + "members": { + "LogFileData": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Entries from the specified log file.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DownloadDBLogFilePortion request.

" + } + }, + "AdditionalDataPending": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean value that if true, indicates there is more data to be downloaded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element to DownloadDBLogFilePortion.

" + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortionMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "LogFileName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the log file to be downloaded.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

" + } + }, + "NumberOfLines": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

\n

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

\n
    \n
  • \n

    If neither Marker or NumberOfLines are specified, the entire log file is returned up to a \n maximum of 10000 lines, starting with the most recent log entries first.

    \n
    • \n
  • \n

    If \n NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end \n of the log file are returned.

    \n
    • \n
  • \n

    If Marker is specified as \"0\", then the specified \n number of lines from the beginning of the log file are returned.

    \n
    • \n
  • \n

    You can \n download the log file in blocks of lines by specifying the size of the block using \n the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your \n first request. Include the Marker value returned in the response as the Marker value for the next \n request, continuing until the AdditionalDataPending response element returns false.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#EC2SecurityGroup": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the EC2 security group.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the id of the EC2 security group.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n AuthorizeDBSecurityGroupIngress\n

    \n
    • \n
  • \n

    \n DescribeDBSecurityGroups\n

    \n
    • \n
  • \n

    \n RevokeDBSecurityGroupIngress\n

    \n
    • \n
" + } + }, + "com.amazonaws.rds#EC2SecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EC2SecurityGroup", + "traits": { + "smithy.api#xmlName": "EC2SecurityGroup" + } + } + }, + "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "Ec2ImagePropertiesNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The AMI configuration prerequisite has not been met.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the DNS address of the DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DeleteDBInstance\n

    \n
    • \n
\n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" + } + }, + "com.amazonaws.rds#EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB parameter group family that the engine default parameters apply to.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

Contains a list of engine default parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" + } + }, + "com.amazonaws.rds#EngineFamily": { + "type": "enum", + "members": { + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + } + } + }, + "com.amazonaws.rds#EngineModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Event": { + "type": "structure", + "members": { + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the identifier for the source of the event.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#SourceType", + "traits": { + "smithy.api#documentation": "

Specifies the source type for this event.

" + } + }, + "Message": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the text of this event.

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

Specifies the category for the event.

" + } + }, + "Date": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the date and time of the event.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeEvents action.

" + } + }, + "com.amazonaws.rds#EventCategoriesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "EventCategory" + } + } + }, + "com.amazonaws.rds#EventCategoriesMap": { + "type": "structure", + "members": { + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source type that the returned categories belong to

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

The event categories for the specified source type

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventCategories\n operation.

" + } + }, + "com.amazonaws.rds#EventCategoriesMapList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EventCategoriesMap", + "traits": { + "smithy.api#xmlName": "EventCategoriesMap" + } + } + }, + "com.amazonaws.rds#EventCategoriesMessage": { + "type": "structure", + "members": { + "EventCategoriesMapList": { + "target": "com.amazonaws.rds#EventCategoriesMapList", + "traits": { + "smithy.api#documentation": "

A list of EventCategoriesMap data types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned from the DescribeEventCategories operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Event", + "traits": { + "smithy.api#xmlName": "Event" + } + } + }, + "com.amazonaws.rds#EventSubscription": { + "type": "structure", + "members": { + "CustomerAwsId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services customer account associated with the RDS event notification subscription.

" + } + }, + "CustSubscriptionId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The RDS event notification subscription Id.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The topic ARN of the RDS event notification subscription.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + } + }, + "SubscriptionCreationTime": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time the RDS event notification subscription was created.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source type for the RDS event notification subscription.

" + } + }, + "SourceIdsList": { + "target": "com.amazonaws.rds#SourceIdsList", + "traits": { + "smithy.api#documentation": "

A list of source IDs for the RDS event notification subscription.

" + } + }, + "EventCategoriesList": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for the RDS event notification subscription.

" + } + }, + "Enabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" + } + }, + "EventSubscriptionArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event subscription.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" + } + }, + "com.amazonaws.rds#EventSubscriptionQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventSubscriptionQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have reached the maximum number of event subscriptions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#EventSubscriptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EventSubscription", + "traits": { + "smithy.api#xmlName": "EventSubscription" + } + } + }, + "com.amazonaws.rds#EventSubscriptionsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "EventSubscriptionsList": { + "target": "com.amazonaws.rds#EventSubscriptionsList", + "traits": { + "smithy.api#documentation": "

A list of EventSubscriptions data types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeEventSubscriptions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#EventsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords.

" + } + }, + "Events": { + "target": "com.amazonaws.rds#EventList", + "traits": { + "smithy.api#documentation": "

A list of Event instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEvents action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.rds#ExportSourceType": { + "type": "enum", + "members": { + "SNAPSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPSHOT" + } + }, + "CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER" + } + } + } + }, + "com.amazonaws.rds#ExportTask": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for\n the Amazon S3 bucket where the data is exported.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

" + } + }, + "ExportOnly": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The data exported from the snapshot or cluster. Valid values are the following:

\n
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
" + } + }, + "SnapshotTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time that the snapshot was created.

" + } + }, + "TaskStartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time that the snapshot or cluster export task started.

" + } + }, + "TaskEndTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time that the snapshot or cluster export task ended.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket that the snapshot or cluster is exported to.

" + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix that is the file name and path of the exported data.

" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. \n The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export\n must have encryption and decryption permissions to use this KMS key.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The progress status of the export task. The status can be one of the following:

\n
    \n
  • \n

    \n CANCELED\n

    \n
    • \n
  • \n

    \n CANCELING\n

    \n
    • \n
  • \n

    \n COMPLETE\n

    \n
    • \n
  • \n

    \n FAILED\n

    \n
    • \n
  • \n

    \n IN_PROGRESS\n

    \n
    • \n
  • \n

    \n STARTING\n

    \n
    • \n
" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress of the snapshot or cluster export task as a percentage.

" + } + }, + "TotalExtractedDataInGB": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total amount of data exported, in gigabytes.

" + } + }, + "FailureCause": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reason the export failed, if it failed.

" + } + }, + "WarningMessage": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A warning about the snapshot or cluster export task.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#ExportSourceType", + "traits": { + "smithy.api#documentation": "

The type of source for the export.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a snapshot or cluster export to Amazon S3.

\n

This data type is used as a response element in the DescribeExportTasks action.

" + } + }, + "com.amazonaws.rds#ExportTaskAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ExportTaskAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't start an export task that's already running.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ExportTaskNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ExportTaskNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The export task doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ExportTasksList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ExportTask", + "traits": { + "smithy.api#xmlName": "ExportTask" + } + } + }, + "com.amazonaws.rds#ExportTasksMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeExportTasks\n request. A marker is used for pagination to identify the location to begin output for\n the next response of DescribeExportTasks.

" + } + }, + "ExportTasks": { + "target": "com.amazonaws.rds#ExportTasksList", + "traits": { + "smithy.api#documentation": "

Information about an export of a snapshot or cluster to Amazon S3.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#FailoverDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#FailoverDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#FailoverDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Forces a failover for a DB cluster.

\n

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.

\n

To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To perform a failover for a DB cluster", + "documentation": "This example performs a failover for the specified DB cluster to the specified DB instance.", + "input": { + "DBClusterIdentifier": "myaurorainstance-cluster", + "TargetDBInstanceIdentifier": "myaurorareplica" + }, + "output": { + "DBCluster": {} + } + } + ] + } + }, + "com.amazonaws.rds#FailoverDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB instance to promote to the primary DB instance.

\n

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.

\n

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#FailoverDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#FailoverGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#FailoverGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#FailoverGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called \"managed planned failovers.\"

\n \n

Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. \n To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead.

\n \n

How you use this operation depends on whether you are failing over or switching over your global database cluster:

\n
    \n
  • \n

    Failing over - Specify the AllowDataLoss parameter and don't specify the Switchover parameter.

    \n
    • \n
  • \n

    Switching over - Specify the Switchover parameter or omit it, but don't specify the AllowDataLoss parameter.

    \n
    • \n
\n

\n About failing over and switching over\n

\n

While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:

\n
    \n
  • \n

    \n Failing over - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. \n Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. \n However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees \n that the data is in a transactionally consistent state.

    \n

    For more information about failing over an Amazon Aurora global database, see\n Performing managed failovers for Aurora global databases in the Amazon Aurora User Guide.

    \n
    • \n
  • \n

    \n Switching over - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to \n fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.

    \n

    For more information about switching over an Amazon Aurora global database, see\n Performing switchovers for Aurora global databases in the Amazon Aurora User Guide.

    \n
    • \n
" + } + }, + "com.amazonaws.rds#FailoverGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the global database cluster (Aurora global database) this operation should apply to. \n The identifier is the unique key assigned by the user when the Aurora global database is created. In other words,\n it's the name of the Aurora global database.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDbClusterIdentifier": { + "target": "com.amazonaws.rds#DBClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "AllowDataLoss": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

\n

If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified together with the Switchover parameter.

    \n
    • \n
" + } + }, + "Switchover": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to switch over this global database cluster.

\n

Constraints:

\n
    \n
  • \n

    Can't be specified together with the AllowDataLoss parameter.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#FailoverGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#FailoverState": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#FailoverStatus", + "traits": { + "smithy.api#documentation": "

The current status of the global cluster. Possible values are as follows:

\n
    \n
  • \n

    pending – The service received a request to switch over or fail over the global cluster. The\n global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation\n starts.

    \n
    • \n
  • \n

    failing-over – This status covers the range of Aurora internal operations that take place during the switchover or failover process, such\n as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.

    \n
    • \n
  • \n

    cancelling – The request to switch over or fail over the global cluster was cancelled and the primary\n Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

    \n
    • \n
" + } + }, + "FromDbClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this\n state.

" + } + }, + "ToDbClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated\n with this state.

" + } + }, + "IsDataLossAllowed": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. \n Otherwise, it's a switchover.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the state of scheduled or in-process operations on a\n global cluster (Aurora global database). This data type is empty unless a switchover \n or failover operation is scheduled or is in progress on the Aurora global database.

" + } + }, + "com.amazonaws.rds#FailoverStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "FAILING_OVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing-over" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + } + } + }, + "com.amazonaws.rds#FeatureNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.rds#FilterValueList", + "traits": { + "smithy.api#documentation": "

One or more filter values. Filter values are case-sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.

\n \n

Currently, wildcards are not supported in filters.

\n \n

The following actions can be filtered:

\n
    \n
  • \n

    \n DescribeDBClusterBacktracks\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n DescribeDBClusters\n

    \n
    • \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribePendingMaintenanceActions\n

    \n
    • \n
" + } + }, + "com.amazonaws.rds#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Filter", + "traits": { + "smithy.api#xmlName": "Filter" + } + } + }, + "com.amazonaws.rds#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.rds#GlobalCluster": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.

" + } + }, + "GlobalClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

" + } + }, + "GlobalClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the global database cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the current state of this global database cluster.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Aurora database engine used by the global database cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the database engine version.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default database name within the new global database cluster.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The storage encryption setting for the global database cluster.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The deletion protection setting for the new global database cluster.

" + } + }, + "GlobalClusterMembers": { + "target": "com.amazonaws.rds#GlobalClusterMemberList", + "traits": { + "smithy.api#documentation": "

The list of primary and secondary clusters within the global database cluster.

" + } + }, + "FailoverState": { + "target": "com.amazonaws.rds#FailoverState", + "traits": { + "smithy.api#documentation": "

A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database).\n This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data type representing an Aurora global database.

" + } + }, + "com.amazonaws.rds#GlobalClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#GlobalClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#GlobalClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#GlobalCluster", + "traits": { + "smithy.api#xmlName": "GlobalClusterMember" + } + } + }, + "com.amazonaws.rds#GlobalClusterMember": { + "type": "structure", + "members": { + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

" + } + }, + "Readers": { + "target": "com.amazonaws.rds#ReadersArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the global cluster.

" + } + }, + "IsWriter": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the Aurora DB cluster is the primary cluster\n (that is, has read-write capability) for the global\n cluster with which it is associated.

" + } + }, + "GlobalWriteForwardingStatus": { + "target": "com.amazonaws.rds#WriteForwardingStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a secondary cluster in the global cluster has\n write forwarding enabled, not enabled, or is in the process of enabling it.

" + } + }, + "SynchronizationStatus": { + "target": "com.amazonaws.rds#GlobalClusterMemberSynchronizationStatus", + "traits": { + "smithy.api#documentation": "

The status of synchronization of each Aurora DB cluster in the global cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data structure with information about any primary and\n secondary clusters associated with a global cluster (Aurora global database).

" + } + }, + "com.amazonaws.rds#GlobalClusterMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#GlobalClusterMember", + "traits": { + "smithy.api#xmlName": "GlobalClusterMember" + } + } + }, + "com.amazonaws.rds#GlobalClusterMemberSynchronizationStatus": { + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "connected" + } + }, + "PENDING_RESYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-resync" + } + } + } + }, + "com.amazonaws.rds#GlobalClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#GlobalClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of global database clusters for this account is already at the maximum allowed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#GlobalClustersMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "GlobalClusters": { + "target": "com.amazonaws.rds#GlobalClusterList", + "traits": { + "smithy.api#documentation": "

The list of global clusters returned by this request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#IAMAuthMode": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + } + }, + "com.amazonaws.rds#IPRange": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the IP range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + } + }, + "com.amazonaws.rds#IPRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#IPRange", + "traits": { + "smithy.api#xmlName": "IPRange" + } + } + }, + "com.amazonaws.rds#IamRoleMissingPermissionsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IamRoleMissingPermissions", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The IAM role requires additional permissions to export to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#IamRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IamRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The IAM role is missing for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#InstanceQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InstanceQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n instances.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientAvailableIPsInSubnetFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed because there aren't enough available IP addresses \n in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required \n from the subnets.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientDBClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBClusterCapacityFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The DB cluster doesn't have enough capacity for the current operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#InsufficientDBInstanceCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBInstanceCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB instance class isn't available in the specified Availability\n Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientStorageClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientStorageClusterCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

There is insufficient storage available for the current action. You might be able to\n resolve this error by updating your subnet group to use different Availability Zones\n that have more storage available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.rds#IntegerOptional": { + "type": "integer" + }, + "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidBlueGreenDeploymentStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in \n the green environment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCustomDBEngineVersionStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't delete the CEV.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterAutomatedBackupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterAutomatedBackupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterCapacityFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n Capacity isn't a valid Aurora Serverless DB cluster\n capacity. Valid capacity values are 2, 4, 8, 16, \n 32, 64, 128, and 256.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterEndpointStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterEndpointStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed on the endpoint while the endpoint is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterSnapshotStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The supplied value isn't a valid DB cluster snapshot state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed while the cluster is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceAutomatedBackupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBInstanceStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB instance isn't in a valid state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBParameterGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBParameterGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB parameter group is in use or is in an invalid state. If you are attempting\n to delete the parameter group, you can't delete it when the parameter group is in\n this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBProxyEndpointStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBProxyEndpointStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't perform this operation while the DB proxy endpoint is in a particular state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBProxyStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBProxyStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed while the proxy is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSecurityGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSecurityGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the DB security group doesn't allow deletion.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSnapshotState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the DB snapshot doesn't allow deletion.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetGroupFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DBSubnetGroup doesn't belong to the same VPC as that of an existing\n cross-region read replica of the same source instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet group cannot be deleted because it's in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet isn't in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidEventSubscriptionStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventSubscriptionState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This error can occur if someone else is modifying a subscription. You should retry the action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportOnlyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportOnly", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The export is invalid for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportSourceStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportSourceState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportTaskStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportTaskStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't cancel an export task that has completed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidGlobalClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidGlobalClusterStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidOptionGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidOptionGroupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The option group isn't in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidRestoreFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRestoreFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Cannot restore from VPC backup to non-VPC DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidS3BucketFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3BucketFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't\n authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidSubnet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidVPCNetworkStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet group doesn't cover all Availability Zones after it's\n created because of users' change.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#KMSKeyNotAccessibleFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSKeyNotAccessibleFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An error occurred accessing an Amazon Web Services KMS key.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#KmsKeyIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_:\\-\\/]+$" + } + }, + "com.amazonaws.rds#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ListTagsForResourceMessage" + }, + "output": { + "target": "com.amazonaws.rds#TagListMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags on an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.

", + "smithy.api#examples": [ + { + "title": "To list tags on an Amazon RDS resource", + "documentation": "The following example lists all tags on a DB instance.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:orcl1" + }, + "output": { + "TagList": [ + { + "Key": "Environment", + "Value": "test" }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.

\n " - } + { + "Key": "Name", + "Value": "MyDatabase" } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} + ] } - }, - "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } + } + ] + } + }, + "com.amazonaws.rds#ListTagsForResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#LocalWriteForwardingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "requested" + } + } + } + }, + "com.amazonaws.rds#LogTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.rds#LongOptional": { + "type": "long" + }, + "com.amazonaws.rds#MasterUserSecret": { + "type": "structure", + "members": { + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" + } + }, + "SecretStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the secret.

\n

The possible status values include the following:

\n
    \n
  • \n

    \n creating - The secret is being created.

    \n
    • \n
  • \n

    \n active - The secret is available for normal use and rotation.

    \n
    • \n
  • \n

    \n rotating - The secret is being rotated.

    \n
    • \n
  • \n

    \n impaired - The secret can be used to access database credentials,\n but it can't be rotated. A secret might have this status if, for example,\n permissions are changed so that RDS can no longer access either the secret or\n the KMS key for the secret.

    \n

    When a secret has this status, you can correct the condition that caused the\n status. Alternatively, modify the DB instance to turn off automatic management\n of database credentials, and then modify the DB instance again to turn on\n automatic management of database credentials.

    \n
    • \n
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" + } + }, + "com.amazonaws.rds#MaxRecords": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 20, + "max": 100 + } + } + }, + "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue": { + "type": "structure", + "members": { + "AllowedValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed value for an option setting.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for the allowed value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for each corresponding allowed value for an option setting.

" + } + }, + "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue", + "traits": { + "smithy.api#xmlName": "MinimumEngineVersionPerAllowedValue" + } + } + }, + "com.amazonaws.rds#ModifyActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.

\n

This operation is supported for RDS for Oracle and Microsoft SQL Server.

" + } + }, + "com.amazonaws.rds#ModifyActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.\n For example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

" + } + }, + "AuditPolicyState": { + "target": "com.amazonaws.rds#AuditPolicyState", + "traits": { + "smithy.api#documentation": "

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is\n read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the modification to the database activity stream.

" + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + }, + "PolicyStatus": { + "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", + "traits": { + "smithy.api#documentation": "

The status of the modification to the policy state of the database activity stream.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCertificatesMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyCertificatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n
    \n
  • \n

    You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet \n the RDS default CA certificate for the specified Amazon Web Services Region.

    \n
    • \n
  • \n

    RDS has already moved to a new default CA certificate for the specified Amazon Web Services\n Region, but you are still in the process of supporting the new CA certificate.\n In this case, you temporarily need additional time to finish your application\n changes.

    \n
    • \n
\n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To temporarily override the system-default SSL/TLS certificate for new DB instances", + "documentation": "The following example temporarily overrides the system-default SSL/TLS certificate for new DB instances.", + "input": { + "CertificateIdentifier": "rds-ca-2019" }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#RestoreWindow": { - "type": "structure", - "members": { - "EarliestTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The earliest time you can restore an instance to.

" - } - }, - "LatestTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The latest time you can restore an instance to.

" - } - } + "output": { + "Certificate": { + "CertificateIdentifier": "rds-ca-2019", + "CertificateType": "CA", + "Thumbprint": "EXAMPLE123456789012", + "ValidFrom": "2019-09-19T18:16:53Z", + "ValidTill": "2024-08-22T17:08:50Z", + "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019", + "CustomerOverride": true, + "CustomerOverrideValidTill": "2024-08-22T17:08:50Z" + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyCertificatesMessage": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.

" + } + }, + "RemoveCustomerOverride": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyCertificatesResult": { + "type": "structure", + "members": { + "Certificate": { + "target": "com.amazonaws.rds#Certificate" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyCurrentDBClusterCapacity": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterCapacityInfo" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

\n

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

\n \n \n

This action only applies to Aurora Serverless v1 DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To scale the capacity of an Aurora Serverless DB cluster", + "documentation": "The following example scales the capacity of an Aurora Serverless DB cluster to 8.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "Capacity": 8 }, - "traits": { - "smithy.api#documentation": "

Earliest and latest time an instance can be restored to:

" + "output": { + "DBClusterIdentifier": "mydbcluster", + "PendingCapacity": 8, + "CurrentCapacity": 1, + "SecondsBeforeTimeout": 300, + "TimeoutAction": "ForceApplyCapacityChange" } + } + ] + } + }, + "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The DB cluster capacity.

\n

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

\n

Constraints:

\n
    \n
  • \n

    For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    \n
    • \n
  • \n

    For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

    \n
    • \n
" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

\n

Specify a value between 10 and 600 seconds.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.

\n \n

For more information, see Modifying CEV status \n in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "

The DB engine. The only supported values are custom-oracle-ee and custom-oracle-ee-cdb.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#documentation": "

The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#Description", + "traits": { + "smithy.api#documentation": "

An optional description of your CEV.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#CustomEngineVersionStatus", + "traits": { + "smithy.api#documentation": "

The availability status to be assigned to the CEV. Valid values are as follows:

\n
\n
available
\n
\n

You can use this CEV to create a new RDS Custom DB instance.

\n
\n
inactive
\n
\n

You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.

\n
\n
\n

You can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, - "com.amazonaws.rds#RevokeDBSecurityGroupIngress": { - "type": "operation", + { + "target": "com.amazonaws.rds#StorageTypeNotAvailableFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

", + "smithy.api#examples": [ + { + "title": "To modify a DB cluster", + "documentation": "The following example changes the master user password for the DB cluster named cluster-2 and sets the backup retention period to 14 days. The ApplyImmediately parameter causes the changes to be made immediately, instead of waiting until the next maintenance window.", "input": { - "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage" + "DBClusterIdentifier": "cluster-2", + "ApplyImmediately": true, + "BackupRetentionPeriod": 14, + "MasterUserPassword": "newpassword99" }, "output": { - "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult" + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": ["eu-central-1b", "eu-central-1c", "eu-central-1a"], + "BackupRetentionPeriod": 14, + "DatabaseName": "", + "DBClusterIdentifier": "cluster-2", + "DBClusterParameterGroup": "default.aurora5.6", + "DBSubnetGroup": "default-vpc-2305ca49", + "Status": "available", + "EarliestRestorableTime": "2020-06-03T02:07:29.637Z", + "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com", + "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora", + "EngineVersion": "5.6.10a", + "LatestRestorableTime": "2020-06-04T15:11:25.748Z", + "Port": 3306, + "MasterUsername": "admin", + "PreferredBackupWindow": "01:55-02:25", + "PreferredMaintenanceWindow": "thu:21:14-thu:21:44", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "cluster-2-instance-1", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-20a5c047", + "Status": "active" + } + ], + "HostedZoneId": "Z1RLNU0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE", + "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-04-03T14:44:02.764Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": true, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To modify a custom DB cluster endpoint", + "documentation": "The following example modifies the specified custom DB cluster endpoint.", + "input": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "StaticMembers": ["dbinstance1", "dbinstance2", "dbinstance3"] }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, + "output": { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "modifying", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": ["dbinstance1", "dbinstance2", "dbinstance3"], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, ANY.

" + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NewDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster2\n

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are \n asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting \n for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next \n maintenance window.

\n

Most modifications can be applied immediately or during the next scheduled maintenance window. Some \n modifications, such as turning on deletion protection and changing the master password, are applied \n immediately—regardless of when you choose to apply them.

\n

By default, this parameter is disabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Default: 1\n

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35.

    \n
    • \n
" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: 1150-65535\n

\n

Default: The same port as the original DB cluster.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new password for the master database user.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB cluster with.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Valid for Cluster Type: Aurora MySQL DB clusters only

\n

Default: 0\n

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" + } + }, + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

The following values are valid for each DB engine:

\n
    \n
  • \n

    Aurora MySQL - audit | error | general | slowquery\n

    \n
    • \n
  • \n

    Aurora PostgreSQL - postgresql\n

    \n
    • \n
  • \n

    RDS for MySQL - error | general | slowquery\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql | upgrade\n

    \n
    • \n
\n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. Changing this\n parameter results in an outage. The change is applied during the next maintenance window\n unless ApplyImmediately is enabled.

\n

If the cluster that you're modifying has one or more read replicas, all replicas must\n be running an engine version that's the same or later than the version you\n specify.

\n

To list all of the available engine versions for Aurora MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query\n \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether major version upgrades are allowed.

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Constraints:

\n
    \n
  • \n

    You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

    \n
    • \n
" + } + }, + "DBInstanceParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Valid for Cluster Type: Aurora DB clusters only

\n

Default: The existing name setting

\n

Constraints:

\n
    \n
  • \n

    The DB parameter group must be in the same DB parameter group family as this DB cluster.

    \n
    • \n
  • \n

    The DBInstanceParameterGroupName parameter is valid in combination with the\n AllowMajorVersionUpgrade parameter for a major version upgrade only.

    \n
    • \n
" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableHttpEndpoint": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableGlobalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster\n (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by a global cluster API operation, but it does nothing until then.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB\n clusters, see Settings for creating Multi-AZ DB clusters.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Valid Values:

\n
    \n
  • \n

    Aurora DB clusters - aurora | aurora-iopt1\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
\n

Default:

\n
    \n
  • \n

    Aurora DB clusters - aurora\n

    \n
    • \n
  • \n

    Multi-AZ DB clusters - io1\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Constraints:

\n
    \n
  • \n

    Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

    \n
    • \n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "RotateMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

\n

Constraints:

\n
    \n
  • \n

    You must apply the change immediately when rotating the master user password.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n
    \n
  • \n

    The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.

    \n

    If the DB cluster already manages the master user password in Amazon Web Services Secrets\n Manager, you can't change the KMS key that is used to encrypt the secret.

    \n
    • \n
  • \n

    You are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.

    \n

    If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

    \n
    • \n
\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n \n

The DB engine mode can be modified only from serverless to provisioned.

\n \n

For more information, see \n CreateDBCluster.

\n

Valid for Cluster Type: Aurora DB clusters only

" + } + }, + "AllowEngineModeChange": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether engine mode changes from serverless to provisioned \n are allowed.

\n

Valid for Cluster Type: Aurora Serverless v1 DB clusters only

\n

Constraints:

\n
    \n
  • \n

    You must allow engine mode changes when specifying a different value for the EngineMode parameter\n from the DB cluster's current engine mode.

    \n
    • \n
" + } + }, + "EnableLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By\n default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To modify parameters in a DB cluster parameter group", + "documentation": "The following example modifies the values of parameters in a DB cluster parameter group.", + "input": { + "DBClusterParameterGroupName": "mydbclusterpg", + "Parameters": [ { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + "ParameterName": "server_audit_logging", + "ParameterValue": "1", + "ApplyMethod": "immediate" }, { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", - "smithy.api#examples": [ - { - "title": "To revoke ingress for a DB security group", - "documentation": "This example revokes ingress for the specified CIDR block associated with the specified DB security group.", - "input": { - "DBSecurityGroupName": "mydbsecuritygroup", - "CIDRIP": "203.0.113.5/32" - }, - "output": { - "DBSecurityGroup": {} - } - } - ] - } - }, - "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group to revoke ingress from.

", - "smithy.api#required": {} - } - }, - "CIDRIP": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n can't be provided.

" - } - }, - "EC2SecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - }, - "EC2SecurityGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - }, - "EC2SecurityGroupOwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } + "ParameterName": "server_audit_logs_upload", + "ParameterValue": "1", + "ApplyMethod": "immediate" } + ] }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} + "output": { + "DBClusterParameterGroupName": "mydbclusterpg" } - }, - "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult": { - "type": "structure", - "members": { - "DBSecurityGroup": { - "target": "com.amazonaws.rds#DBSecurityGroup" - } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to modify.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

", + "smithy.api#examples": [ + { + "title": "To modify a DB cluster snapshot attribute", + "documentation": "The following example makes changes to the specified DB cluster snapshot attribute.", + "input": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "AttributeName": "restore", + "ValuesToAdd": ["123456789012"] }, - "traits": { - "smithy.api#output": {} + "output": { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": ["123456789012"] + } + ] + } } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB cluster snapshot to modify the attributes for.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.

\n ", + "smithy.api#required": {} + } + }, + "ValuesToAdd": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" + } + }, + "ValuesToRemove": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult": { + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, - "com.amazonaws.rds#SNSInvalidTopicFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SNSInvalidTopic", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

SNS has responded that there is a problem with the SNS topic specified.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, - "com.amazonaws.rds#SNSNoAuthorizationFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SNSNoAuthorization", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You do not have permission to publish to the SNS topic ARN.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" }, - "com.amazonaws.rds#SNSTopicArnNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SNSTopicArnNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The SNS topic ARN does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, - "com.amazonaws.rds#ScalingConfiguration": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The minimum capacity must be less than or equal to the maximum capacity.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The maximum capacity must be greater than or equal to the minimum capacity.

" - } - }, - "AutoPause": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

\n " - } - }, - "SecondsUntilAutoPause": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

\n

Specify a value between 300 and 86,400 seconds.

" - } - }, - "TimeoutAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

\n \n

If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless v1 from finding a scaling point might be dropped.

\n \n

For more information, see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

" - } - }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.

\n

Specify a value between 60 and 600 seconds.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" - } + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, - "com.amazonaws.rds#ScalingConfigurationInfo": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

" - } - }, - "AutoPause": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

" - } - }, - "SecondsUntilAutoPause": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The remaining amount of time, in seconds, before the Aurora DB cluster in\n serverless mode is paused. A DB cluster can be paused only when\n it's idle (it has no connections).

" - } - }, - "TimeoutAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or\n RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" - } - }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds before scaling times out. What happens when an attempted scaling action times out\n is determined by the TimeoutAction setting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" - } + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, - "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" - } + { + "target": "com.amazonaws.rds#DBUpgradeDependencyFailureFault" }, - "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" - } + { + "target": "com.amazonaws.rds#DomainNotFoundFault" }, - "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SharedSnapshotQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, - "com.amazonaws.rds#SnapshotQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SnapshotQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n snapshots.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, - "com.amazonaws.rds#SourceClusterNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SourceClusterNotSupportedFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The source DB cluster isn't supported for a blue/green deployment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, - "com.amazonaws.rds#SourceDatabaseNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SourceDatabaseNotSupportedFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The source DB instance isn't supported for a blue/green deployment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" }, - "com.amazonaws.rds#SourceIdsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "SourceId" - } - } + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, - "com.amazonaws.rds#SourceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SourceNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The requested source could not be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, - "com.amazonaws.rds#SourceRegion": { - "type": "structure", - "members": { - "RegionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the source Amazon Web Services Region.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The endpoint for the source Amazon Web Services Region endpoint.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the source Amazon Web Services Region.

" - } - }, - "SupportsDBInstanceAutomatedBackupsReplication": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

" - } + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.

", + "smithy.api#examples": [ + { + "title": "To modify a DB instance", + "documentation": "The following example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ApplyImmediately parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.", + "input": { + "DBInstanceIdentifier": "database-2", + "ApplyImmediately": true, + "DBParameterGroupName": "test-sqlserver-se-2017", + "OptionGroupName": "test-se-2017" + }, + "output": { + "DBInstance": { + "DBInstanceIdentifier": "database-2", + "DBInstanceClass": "db.r4.large", + "Engine": "sqlserver-se", + "DBInstanceStatus": "available", + "DBParameterGroups": [ + { + "DBParameterGroupName": "test-sqlserver-se-2017", + "ParameterApplyStatus": "applying" + } + ], + "AvailabilityZone": "us-west-2d", + "MultiAZ": true, + "EngineVersion": "14.00.3281.6.v1", + "AutoMinorVersionUpgrade": false, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "license-included", + "OptionGroupMemberships": [ + { + "OptionGroupName": "test-se-2017", + "Status": "pending-apply" + } + ], + "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS", + "SecondaryAvailabilityZone": "us-west-2c", + "PubliclyAccessible": true, + "StorageType": "gp2", + "DeletionProtection": false, + "AssociatedRoles": [], + "MaxAllocatedStorage": 1000 + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of DB instance to modify. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB instance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.

\n

Default: Uses existing setting

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This parameter doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing DB subnet group.

    \n
    • \n
\n

Example: mydbsubnetgroup\n

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing DB security groups.

    \n
    • \n
" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    If supplied, must match existing VPC security group IDs.

    \n
    • \n
" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new password for the master user.

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n \n

This setting doesn't apply to the following DB instances:

\n
    \n
  • \n

    Amazon Aurora (The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.)

    \n
    • \n
  • \n

    RDS Custom

    \n
    • \n
\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
  • \n

    Can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    \n
    • \n
\n

Length Constraints:

\n
    \n
  • \n

    RDS for MariaDB - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.

    \n
    • \n
  • \n

    RDS for MySQL - Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    RDS for Oracle - Must contain from 8 to 30 characters.

    \n
    • \n
  • \n

    RDS for PostgreSQL - Must contain from 8 to 128 characters.

    \n
    • \n
" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be in the same DB parameter group family as the DB instance.

    \n
    • \n
" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to \n read replicas.

    \n
    • \n
  • \n

    Can't be set to 0 for an RDS Custom for Oracle DB instance.

    \n
    • \n
" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter causes a reboot\n of the DB instance. If you change this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    The day values must be mon | tue | wed | thu | fri | sat | sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS updates the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

If the instance that you're modifying is acting as a read replica, the engine version\n that you specify must be the same or higher than the version that the source DB instance\n or cluster is running.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that's a different major version than the DB instance's current version.

    \n
    • \n
" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n
    \n
  • \n

    The automatic upgrade is enabled for the maintenance window.

    \n
    • \n
  • \n

    A newer minor version is available.

    \n
    • \n
  • \n

    RDS has enabled automatic patching for the engine version.

    \n
    • \n
\n

If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    RDS for MariaDB - general-public-license\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - license-included\n

    \n
    • \n
  • \n

    RDS for MySQL - general-public-license\n

    \n
    • \n
  • \n

    RDS for Oracle - bring-your-own-license | license-included\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - postgresql-license\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Constraints:

\n
    \n
  • \n

    For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for PostgreSQL - The value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    \n
    • \n
\n

Default: Uses existing setting

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to associate the DB instance with.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "NewDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type to associate with the DB instance.

\n

If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Valid Values: gp2 | gp3 | io1 | standard\n

\n

Default: io1, if the Iops parameter\n is specified. Otherwise, gp2.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA certificate identifier to use for the DB instance's server certificate.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied.

\n

This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

" + } + }, + "DBPortNumber": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values: 1150-65535\n

\n

Default:

\n
    \n
  • \n

    Amazon Aurora - 3306\n

    \n
    • \n
  • \n

    RDS for MariaDB - 3306\n

    \n
    • \n
  • \n

    RDS for Microsoft SQL Server - 1433\n

    \n
    • \n
  • \n

    RDS for MySQL - 3306\n

    \n
    • \n
  • \n

    RDS for Oracle - 1521\n

    \n
    • \n
  • \n

    RDS for PostgreSQL - 5432\n

    \n
    • \n
\n

Constraints:

\n
    \n
  • \n

    For RDS for Microsoft SQL Server, the value can't be 1234, 1434,\n 3260, 3343, 3389, 47001, or\n 49152-49156.

    \n
    • \n
" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DisableDomain": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to remove the DB instance from the Active Directory domain.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The order of priority in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Default: 1\n

\n

Valid Values: 0 - 15\n

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

This setting doesn't apply to RDS Custom DB instances.

\n

Valid Values:

\n
    \n
  • \n

    \n 7\n

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23. \n Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

    \n
    • \n
  • \n

    \n 731\n

    \n
    • \n
\n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

" + } + }, + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", + "traits": { + "smithy.api#documentation": "

The log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "CertificateRotationRestart": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.

" + } + }, + "ResumeFullAutomationModeMinutes": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation.

\n

Default: 60\n

\n

Constraints:

\n
    \n
  • \n

    Must be at least 60.

    \n
    • \n
  • \n

    Must be no more than 1,440.

    \n
    • \n
" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

\n

Valid Values: IPV4 | DUAL\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "RotateMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    You must apply the change immediately when rotating the master user password.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n
    \n
  • \n

    The DB instance doesn't manage the master user password in Amazon Web Services Secrets Manager.

    \n

    If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, \n you can't change the KMS key used to encrypt the secret.

    \n
    • \n
  • \n

    You are turning on ManageMasterUserPassword to manage the master user password \n in Amazon Web Services Secrets Manager.

    \n

    If you are turning on ManageMasterUserPassword and don't specify \n MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

    \n
    • \n
\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB\n to an Oracle Database 21c CDB.

\n

Note the following requirements:

\n
    \n
  • \n

    Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.

    \n
    • \n
  • \n

    Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.

    \n
    • \n
\n

Note the following limitations:

\n
    \n
  • \n

    You can't convert a CDB to a non-CDB.

    \n
    • \n
  • \n

    You can't convert a replica database.

    \n
    • \n
  • \n

    You can't convert a non-CDB to a CDB and upgrade the engine version in the\n same command.

    \n
    • \n
  • \n

    You can't convert the existing custom parameter or option group when it has\n options or parameters that are permanent or persistent. In this situation, the\n DB instance reverts to the default option and parameter group. To avoid\n reverting to the default, specify a new parameter group with\n --db-parameter-group-name and a new option group with\n --option-group-name.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n ", + "smithy.api#examples": [ + { + "title": "To modify a DB parameter group", + "documentation": "The following example changes the value of the clr enabled parameter in a DB parameter group. The value of the ApplyMethod parameter causes the DB parameter group to be modified immediately, instead of waiting until the next maintenance window.", + "input": { + "DBParameterGroupName": "test-sqlserver-se-2017", + "Parameters": [ + { + "ParameterName": "clr enabled", + "ParameterValue": "1", + "ApplyMethod": "immediate" } + ] }, - "traits": { - "smithy.api#documentation": "

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

" + "output": { + "DBParameterGroupName": "test-sqlserver-se-2017" } - }, - "com.amazonaws.rds#SourceRegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#SourceRegion", - "traits": { - "smithy.api#xmlName": "SourceRegion" - } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.

\n

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.

\n \n

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

\n \n

For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the settings for an existing DB proxy.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the settings for an existing DB proxy endpoint.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

", + "smithy.api#required": {} + } + }, + "NewDBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The new identifier for the DBProxyEndpoint. An identifier must\n begin with a letter and must contain only ASCII letters, digits, and hyphens; it\n can't end with a hyphen or contain two consecutive hyphens.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint\n uses a different VPC than the original proxy, you also specify a different\n set of security group IDs than for the original proxy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DBProxy to modify.

", + "smithy.api#required": {} + } + }, + "NewDBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigList", + "traits": { + "smithy.api#documentation": "

The new authentication settings for the DBProxy.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't\n use TLS.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The new list of security groups for the DBProxy.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The DBProxy object representing the new settings for the proxy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the properties of a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest": { + "type": "structure", + "members": { + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the target group to modify.

", + "smithy.api#required": {} + } + }, + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the proxy.

", + "smithy.api#required": {} + } + }, + "ConnectionPoolConfig": { + "target": "com.amazonaws.rds#ConnectionPoolConfiguration", + "traits": { + "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" + } + }, + "NewName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse": { + "type": "structure", + "members": { + "DBProxyTargetGroup": { + "target": "com.amazonaws.rds#DBProxyTargetGroup", + "traits": { + "smithy.api#documentation": "

The settings of the modified DBProxyTarget.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

", + "smithy.api#examples": [ + { + "title": "To modify a DB snapshot", + "documentation": "The following example upgrades a PostgeSQL 10.6 snapshot named db5-snapshot-upg-test to PostgreSQL 11.7. The new DB engine version is shown after the snapshot has finished upgrading and its status is available.", + "input": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "EngineVersion": "11.7" + }, + "output": { + "DBSnapshot": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "DBInstanceIdentifier": "database-5", + "SnapshotCreateTime": "2020-03-27T20:49:17.092Z", + "Engine": "postgres", + "AllocatedStorage": 20, + "Status": "upgrading", + "Port": 5432, + "AvailabilityZone": "us-west-2a", + "VpcId": "vpc-2ff27557", + "InstanceCreateTime": "2020-03-27T19:59:04.735Z", + "MasterUsername": "postgres", + "EngineVersion": "10.6", + "LicenseModel": "postgresql-license", + "SnapshotType": "manual", + "OptionGroupName": "default:postgres-11", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-GJMF75LM42IL6BTFRE4UZJ5YM4" + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.

", + "smithy.api#examples": [ + { + "title": "To allow two AWS accounts to restore a DB snapshot", + "documentation": "The following example grants permission to two AWS accounts, with the identifiers 111122223333 and 444455556666, to restore the DB snapshot named mydbsnapshot.", + "input": { + "DBSnapshotIdentifier": "mydbsnapshot", + "AttributeName": "restore", + "ValuesToAdd": ["111122223333", "444455556666"] + }, + "output": { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": ["111122223333", "444455556666"] + } + ] + } } - }, - "com.amazonaws.rds#SourceRegionMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "SourceRegions": { - "target": "com.amazonaws.rds#SourceRegionList", - "traits": { - "smithy.api#documentation": "

A list of SourceRegion instances that contains each source Amazon Web Services Region that the\n current Amazon Web Services Region can get a read replica or a DB snapshot from.

" - } - } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot to modify the attributes for.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.

\n ", + "smithy.api#required": {} + } + }, + "ValuesToAdd": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" + } + }, + "ValuesToRemove": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttributeResult": { + "type": "structure", + "members": { + "DBSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBSnapshotAttributesResult" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB snapshot to modify.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n
    \n
  • \n

    \n 5.5.46 (supported for 5.1 DB snapshots)

    \n
    • \n
\n

\n Oracle\n

\n
    \n
  • \n

    \n 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB\n snapshots)

    \n
    • \n
  • \n

    \n 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB\n snapshots)

    \n
    • \n
  • \n

    \n 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

    \n
    • \n
  • \n

    \n 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    \n
    • \n
\n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.

\n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSubnetGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#SubnetAlreadyInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

", + "smithy.api#examples": [ + { + "title": "To modify a DB subnet group", + "documentation": "The following example adds a subnet with the ID subnet-08e41f9e230222222 to the DB subnet group named mysubnetgroup. To keep the existing subnets in the subnet group, include their IDs as values in the --subnet-ids option. Make sure to have subnets with at least two different Availability Zones in the DB subnet group.", + "input": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "", + "SubnetIds": [ + "subnet-0a1dc4e1a6f123456", + "subnet-070dd7ecb3aaaaaaa", + "subnet-00f5b198bc0abcdef", + "subnet-08e41f9e230222222" + ] }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeSourceRegions action.

", - "smithy.api#output": {} + "output": { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-08e41f9e230222222", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:mysubnetgroup" + } } - }, - "com.amazonaws.rds#SourceType": { - "type": "enum", - "members": { - "db_instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-instance" - } - }, - "db_parameter_group": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-parameter-group" - } - }, - "db_security_group": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-security-group" - } - }, - "db_snapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-snapshot" - } - }, - "db_cluster": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-cluster" - } - }, - "db_cluster_snapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-cluster-snapshot" - } - }, - "custom_engine_version": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "custom-engine-version" - } - }, - "db_proxy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-proxy" - } - }, - "blue_green_deployment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "blue-green-deployment" - } + } + ] + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB subnet group.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.rds#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the DB subnet group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroupResult": { + "type": "structure", + "members": { + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#SNSInvalidTopicFault" + }, + { + "target": "com.amazonaws.rds#SNSNoAuthorizationFault" + }, + { + "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

\n

You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

", + "smithy.api#examples": [ + { + "title": "To modify an event subscription", + "documentation": "The following example turns off the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic.", + "input": { + "SubscriptionName": "my-instance-events", + "Enabled": false + }, + "output": { + "EventSubscription": { + "EventCategoriesList": ["backup", "recovery"], + "CustomerAwsId": "123456789012", + "SourceType": "db-instance", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustSubscriptionId": "my-instance-events", + "Status": "modifying", + "Enabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription.

", + "smithy.api#required": {} + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" + } + }, + "Enabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to activate the subscription.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies a setting for an Amazon Aurora global database cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This operation only applies to Aurora global database clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To modify a global database cluster", + "documentation": "The following example enables deletion protection for an Aurora MySQL-based global database cluster.", + "input": { + "GlobalClusterIdentifier": "myglobalcluster", + "DeletionProtection": true + }, + "output": { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f0e523bfe07aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": true, + "GlobalClusterMembers": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#ModifyGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster.

    \n
    • \n
" + } + }, + "NewGlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new cluster identifier for the global database cluster.\n This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster2\n

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable deletion protection for the global database cluster. The global database cluster\n can't be deleted when deletion protection is enabled.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n

\n

To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to allow major version upgrades.

\n

Constraints: Must be enabled if you specify a value for the\n EngineVersion parameter that's a different major version than the global\n cluster's current version.

\n

If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ModifyOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing option group.

", + "smithy.api#examples": [ + { + "title": "To modify an option group", + "documentation": "The following example adds an option to an option group.", + "input": { + "OptionGroupName": "myawsuser-og02", + "OptionsToInclude": [ + { + "OptionName": "MEMCACHED", + "DBSecurityGroupMemberships": ["default"] } + ], + "ApplyImmediately": true + }, + "output": { + "OptionGroup": {} } - }, - "com.amazonaws.rds#StartActivityStream": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.rds#ModifyOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be modified.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

", + "smithy.api#required": {} + } + }, + "OptionsToInclude": { + "target": "com.amazonaws.rds#OptionConfigurationList", + "traits": { + "smithy.api#documentation": "

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

" + } + }, + "OptionsToRemove": { + "target": "com.amazonaws.rds#OptionNamesList", + "traits": { + "smithy.api#documentation": "

Options in this list are removed from the option group.

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ModifyOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#NetworkTypeNotSupported": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NetworkTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#Option": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option.

" + } + }, + "OptionDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option.

" + } + }, + "Persistent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicate if this option is persistent.

" + } + }, + "Permanent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicate if this option is permanent.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

If required, the port configured for this option to use.

" + } + }, + "OptionVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the option.

" + } + }, + "OptionSettings": { + "target": "com.amazonaws.rds#OptionSettingConfigurationList", + "traits": { + "smithy.api#documentation": "

The option settings for this option.

" + } + }, + "DBSecurityGroupMemberships": { + "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

If the option requires access to a port, then this DB security group allows access to the port.

" + } + }, + "VpcSecurityGroupMemberships": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

If the option requires access to a port, then this VPC security group allows access to the port.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option details.

" + } + }, + "com.amazonaws.rds#OptionConfiguration": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The configuration of options to include in a group.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The optional port for the option.

" + } + }, + "OptionVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version for the option.

" + } + }, + "DBSecurityGroupMemberships": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DBSecurityGroupMembership name strings used for this option.

" + } + }, + "VpcSecurityGroupMemberships": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VpcSecurityGroupMembership name strings used for this option.

" + } + }, + "OptionSettings": { + "target": "com.amazonaws.rds#OptionSettingsList", + "traits": { + "smithy.api#documentation": "

The option settings to include in an option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of all available options

" + } + }, + "com.amazonaws.rds#OptionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionConfiguration", + "traits": { + "smithy.api#xmlName": "OptionConfiguration" + } + } + }, + "com.amazonaws.rds#OptionGroup": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group.

" + } + }, + "OptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides a description of the option group.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the name of the engine that this option group can be applied to.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the major engine version associated with this option group.

" + } + }, + "Options": { + "target": "com.amazonaws.rds#OptionsList", + "traits": { + "smithy.api#documentation": "

Indicates what options are available in the option group.

" + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.

" + } + }, + "OptionGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the option group.

" + } + }, + "SourceOptionGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group from which this option group is copied.

" + } + }, + "SourceAccountId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

" + } + }, + "CopyTimestamp": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Indicates when the option group was copied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#OptionGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The option group you are trying to create already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#OptionGroupMembership": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group that the instance belongs to.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are: \n in-sync, \n pending-apply, \n pending-removal, \n pending-maintenance-apply, \n pending-maintenance-removal, \n applying, \n removing, \n and failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information on the option groups the DB instance is a member of.

" + } + }, + "com.amazonaws.rds#OptionGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupMembership", + "traits": { + "smithy.api#xmlName": "OptionGroupMembership" + } + } + }, + "com.amazonaws.rds#OptionGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified option group could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#OptionGroupOption": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the engine that this option can be applied to.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the major engine version that the option is available for.

" + } + }, + "MinimumRequiredMinorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The minimum required engine version for the option to be applied.

" + } + }, + "PortRequired": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the option requires a port.

" + } + }, + "DefaultPort": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

If the option requires a port, specifies the default port for the option.

" + } + }, + "OptionsDependedOn": { + "target": "com.amazonaws.rds#OptionsDependedOn", + "traits": { + "smithy.api#documentation": "

The options that are prerequisites for this option.

" + } + }, + "OptionsConflictsWith": { + "target": "com.amazonaws.rds#OptionsConflictsWith", + "traits": { + "smithy.api#documentation": "

The options that conflict with this option.

" + } + }, + "Persistent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

" + } + }, + "Permanent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

" + } + }, + "RequiresAutoMinorEngineVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.

" + } + }, + "VpcOnly": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, you can only use this option with a DB instance that is in a VPC.

" + } + }, + "SupportsOptionVersionDowngrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.

" + } + }, + "OptionGroupOptionSettings": { + "target": "com.amazonaws.rds#OptionGroupOptionSettingsList", + "traits": { + "smithy.api#documentation": "

The option settings that are available (and the default value) for each option in an option group.

" + } + }, + "OptionGroupOptionVersions": { + "target": "com.amazonaws.rds#OptionGroupOptionVersionsList", + "traits": { + "smithy.api#documentation": "

The versions that are available for the option.

" + } + }, + "CopyableCrossAccount": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the option can be copied across Amazon Web Services accounts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Available option.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionSetting": { + "type": "structure", + "members": { + "SettingName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group option.

" + } + }, + "SettingDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option group option.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value for the option group option.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine specific parameter type for the option group option.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the acceptable values for the option group option.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean value where true indicates that this option group option can be changed from the default value.

" + } + }, + "IsRequired": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

" + } + }, + "MinimumEngineVersionPerAllowedValue": { + "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList", + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for the corresponding allowed value for this option setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupOptionSetting", + "traits": { + "smithy.api#xmlName": "OptionGroupOptionSetting" + } + } + }, + "com.amazonaws.rds#OptionGroupOptionVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionVersion", + "traits": { + "smithy.api#xmlName": "OptionVersion" + } + } + }, + "com.amazonaws.rds#OptionGroupOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupOption", + "traits": { + "smithy.api#xmlName": "OptionGroupOption" + } + }, + "traits": { + "smithy.api#documentation": "

List of available option group options.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionsMessage": { + "type": "structure", + "members": { + "OptionGroupOptions": { + "target": "com.amazonaws.rds#OptionGroupOptionsList" + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#OptionGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota of 20 option groups was exceeded for this Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#OptionGroups": { + "type": "structure", + "members": { + "OptionGroupsList": { + "target": "com.amazonaws.rds#OptionGroupsList", + "traits": { + "smithy.api#documentation": "

List of option groups.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of option groups.

" + } + }, + "com.amazonaws.rds#OptionGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroup", + "traits": { + "smithy.api#xmlName": "OptionGroup" + } + } + }, + "com.amazonaws.rds#OptionNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#OptionSetting": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option that has settings that you can set.

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current value of the option setting.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value of the option setting.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option setting.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine specific parameter type.

" + } + }, + "DataType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The data type of the option setting.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed values of the option setting.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that, when true, indicates the option setting can be modified from the default.

" + } + }, + "IsCollection": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the option setting is part of a collection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" + } + }, + "com.amazonaws.rds#OptionSettingConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionSetting", + "traits": { + "smithy.api#xmlName": "OptionSetting" + } + } + }, + "com.amazonaws.rds#OptionSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionSetting", + "traits": { + "smithy.api#xmlName": "OptionSetting" + } + } + }, + "com.amazonaws.rds#OptionVersion": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the option.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if the version is the default version of the option, and otherwise false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The version for an option. Option group option versions are returned by \n the DescribeOptionGroupOptions action.

" + } + }, + "com.amazonaws.rds#OptionsConflictsWith": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "OptionConflictName" + } + } + }, + "com.amazonaws.rds#OptionsDependedOn": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "OptionName" + } + } + }, + "com.amazonaws.rds#OptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Option", + "traits": { + "smithy.api#xmlName": "Option" + } + } + }, + "com.amazonaws.rds#OrderableDBInstanceOption": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine type of a DB instance.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version of a DB instance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for a DB instance.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for a DB instance.

" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone group for a DB instance.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones for a DB instance.

" + } + }, + "MultiAZCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance is Multi-AZ capable.

" + } + }, + "ReadReplicaCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance can have a read replica.

" + } + }, + "Vpc": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance is in a VPC.

" + } + }, + "SupportsStorageEncryption": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports encrypted storage.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the storage type for a DB instance.

" + } + }, + "SupportsIops": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports provisioned IOPS.

" + } + }, + "SupportsEnhancedMonitoring": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

" + } + }, + "SupportsIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports IAM database authentication.

" + } + }, + "SupportsPerformanceInsights": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if a DB instance supports Performance Insights, otherwise false.

" + } + }, + "MinStorageSize": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage size for a DB instance.

" + } + }, + "MaxStorageSize": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage size for a DB instance.

" + } + }, + "MinIopsPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum total provisioned IOPS for a DB instance.

" + } + }, + "MaxIopsPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum total provisioned IOPS for a DB instance.

" + } + }, + "MinIopsPerGib": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Minimum provisioned IOPS per GiB for a DB instance.

" + } + }, + "MaxIopsPerGib": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Maximum provisioned IOPS per GiB for a DB instance.

" + } + }, + "AvailableProcessorFeatures": { + "target": "com.amazonaws.rds#AvailableProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

A list of the available processor features for the DB instance class of a DB instance.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes.

" + } + }, + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

" + } + }, + "SupportsKerberosAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether a DB instance supports Kerberos Authentication.

" + } + }, + "OutpostCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "SupportedActivityStreamModes": { + "target": "com.amazonaws.rds#ActivityStreamModeList", + "traits": { + "smithy.api#documentation": "

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync,\n async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams \n isn't supported, the return value is an empty list.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

" + } + }, + "SupportsClusters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether DB instances can be configured as a Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "SupportsStorageThroughput": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports storage throughput.

" + } + }, + "MinStorageThroughputPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage throughput for a DB instance.

" + } + }, + "MaxStorageThroughputPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage throughput for a DB instance.

" + } + }, + "MinStorageThroughputPerIops": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

" + } + }, + "MaxStorageThroughputPerIops": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a list of available options for a DB instance.

\n

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" + } + }, + "com.amazonaws.rds#OrderableDBInstanceOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OrderableDBInstanceOption", + "traits": { + "smithy.api#xmlName": "OrderableDBInstanceOption" + } + } + }, + "com.amazonaws.rds#OrderableDBInstanceOptionsMessage": { + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "target": "com.amazonaws.rds#OrderableDBInstanceOptionsList", + "traits": { + "smithy.api#documentation": "

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#Outpost": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "com.amazonaws.rds#Parameter": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the parameter.

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the value of the parameter.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides a description of the parameter.

" + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the source of the parameter value.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the engine specific parameters type.

" + } + }, + "DataType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" + } + }, + "ApplyMethod": { + "target": "com.amazonaws.rds#ApplyMethod", + "traits": { + "smithy.api#documentation": "

Indicates when to apply parameter updates.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

The valid DB engine modes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

" + } + }, + "com.amazonaws.rds#ParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Parameter", + "traits": { + "smithy.api#xmlName": "Parameter" + } + } + }, + "com.amazonaws.rds#PendingCloudwatchLogsExports": { + "type": "structure", + "members": { + "LogTypesToEnable": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

" + } + }, + "LogTypesToDisable": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

" + } + }, + "com.amazonaws.rds#PendingMaintenanceAction": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource. \n Valid actions are system-update, db-upgrade, hardware-maintenance, \n and ca-certificate-rotation.

" + } + }, + "AutoAppliedAfterDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date of the maintenance window when the action is applied.\n The maintenance action is applied to the resource during\n its first maintenance window after this date.

" + } + }, + "ForcedApplyDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the maintenance action is automatically applied.

\n

On this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.

" + } + }, + "OptInStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the type of opt-in request that has been received for the resource.

" + } + }, + "CurrentApplyDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The effective date when the pending maintenance action is applied \n to the resource. This date takes into account opt-in requests received from\n the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate,\n and the ForcedApplyDate. This value is blank if an \n opt-in request has not been received and nothing has been specified as\n AutoAppliedAfterDate or ForcedApplyDate.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

" + } + }, + "com.amazonaws.rds#PendingMaintenanceActionDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#PendingMaintenanceAction", + "traits": { + "smithy.api#xmlName": "PendingMaintenanceAction" + } + } + }, + "com.amazonaws.rds#PendingMaintenanceActions": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions", + "traits": { + "smithy.api#xmlName": "ResourcePendingMaintenanceActions" + } + } + }, + "com.amazonaws.rds#PendingMaintenanceActionsMessage": { + "type": "structure", + "members": { + "PendingMaintenanceActions": { + "target": "com.amazonaws.rds#PendingMaintenanceActions", + "traits": { + "smithy.api#documentation": "

A list of the pending maintenance actions for the resource.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned from the DescribePendingMaintenanceActions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class for the DB instance.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The allocated storage size for the DB instance specified in gibibytes (GiB).

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master credentials for the DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port for the DB instance.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for the DB instance.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS value for the DB instance.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database identifier for the DB instance.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type of the DB instance.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the CA certificate for the DB instance.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group for the DB instance.

" + } + }, + "PendingCloudwatchLogsExports": { + "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all-paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all-paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" + } + }, + "ResumeFullAutomationModeTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput of the DB instance.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine of the DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBInstance operation and \n contains changes that will be applied during the next maintenance window.

" + } + }, + "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PointInTimeRestoreNotEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ProcessorFeature": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount and threadsPerCore.

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The value of a processor feature name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the processor features of a DB instance class.

\n

To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

\n

You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

\n
    \n
  • \n

    \n CreateDBInstance\n

    \n
    • \n
  • \n

    \n ModifyDBInstance\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromDBSnapshot\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceFromS3\n

    \n
    • \n
  • \n

    \n RestoreDBInstanceToPointInTime\n

    \n
    • \n
\n

You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

\n

In addition, you can use the following actions for DB instance class processor information:

\n
    \n
  • \n

    \n DescribeDBInstances\n

    \n
    • \n
  • \n

    \n DescribeDBSnapshots\n

    \n
    • \n
  • \n

    \n DescribeValidDBInstanceModifications\n

    \n
    • \n
\n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n
    \n
  • \n

    You are accessing an Oracle DB instance.

    \n
    • \n
  • \n

    Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.

    \n
    • \n
  • \n

    The current number CPU cores and threads is set to a non-default value.

    \n
    • \n
\n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" + } + }, + "com.amazonaws.rds#ProcessorFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ProcessorFeature", + "traits": { + "smithy.api#xmlName": "ProcessorFeature" + } + } + }, + "com.amazonaws.rds#PromoteReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PromoteReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#PromoteReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes a read replica DB instance to a standalone DB instance.

\n \n
    \n
  • \n

    Backup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.

    \n
    • \n
  • \n

    This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.

    \n
    • \n
\n ", + "smithy.api#examples": [ + { + "title": "To promote a read replica", + "documentation": "The following example promotes the specified read replica to become a standalone DB instance.", "input": { - "target": "com.amazonaws.rds#StartActivityStreamRequest" + "DBInstanceIdentifier": "test-instance-repl" }, "output": { - "target": "com.amazonaws.rds#StartActivityStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a database activity stream to monitor activity on the database.\n For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide or\n \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

", - "smithy.api#examples": [ - { - "title": "To start a database activity stream", - "documentation": "The following example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.", - "input": { - "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", - "Mode": "async", - "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", - "ApplyImmediately": true - }, - "output": { - "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", - "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", - "Status": "starting", - "Mode": "async", - "ApplyImmediately": true - } - } - ] - } - }, - "com.amazonaws.rds#StartActivityStreamRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster,\n for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", - "smithy.api#required": {} - } - }, - "Mode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.\n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

", - "smithy.api#required": {} - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.

" - } - }, - "EngineNativeAuditFieldsIncluded": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the database activity stream includes engine-native audit fields. This option applies\n to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#StartActivityStreamResponse": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" - } - }, - "KinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream.

" - } - }, - "Mode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

The mode of the database activity stream.

" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

" - } - }, - "EngineNativeAuditFieldsIncluded": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" - } - } + "DBInstance": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "StorageType": "standard", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "modifying" + } + } + } + ] + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes a read replica DB cluster to a standalone DB cluster.

" + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB cluster read replica.

    \n
    • \n
\n

Example: my-cluster-replica1\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#PromoteReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing read replica DB instance.

    \n
    • \n
\n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 0 to 35.

    \n
    • \n
  • \n

    Can't be set to 0 if the DB instance is a source to read replicas.

    \n
    • \n
" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#PromoteReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ProvisionedIopsNotAvailableInAZFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Provisioned IOPS not available in the specified Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage" + }, + "output": { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Purchases a reserved DB instance offering.

", + "smithy.api#examples": [ + { + "title": "To purchase a reserved DB instance", + "documentation": "The following example shows how to buy the reserved DB instance offering from the previous example.", + "input": { + "ReservedDBInstancesOfferingId": "", + "ReservedDBInstanceId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4" }, - "traits": { - "smithy.api#output": {} + "output": { + "ReservedDBInstance": { + "ReservedDBInstanceId": "ri-2020-06-29-16-54-57-670", + "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", + "DBInstanceClass": "db.t2.micro", + "StartTime": "2020-06-29T16:54:57.670Z", + "Duration": 31536000, + "FixedPrice": 51, + "UsagePrice": 0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "mysql", + "OfferingType": "Partial Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.006, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670" + } } - }, - "com.amazonaws.rds#StartDBCluster": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the Reserved DB instance offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", + "smithy.api#required": {} + } + }, + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Customer-specified identifier to track this reservation.

\n

Example: myreservationID

" + } + }, + "DBInstanceCount": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of instances to reserve.

\n

Default: 1\n

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult": { + "type": "structure", + "members": { + "ReservedDBInstance": { + "target": "com.amazonaws.rds#ReservedDBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#Range": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum value in the range.

" + } + }, + "To": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum value in the range.

" + } + }, + "Step": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of integer values.

" + } + }, + "com.amazonaws.rds#RangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Range", + "traits": { + "smithy.api#xmlName": "Range" + } + } + }, + "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaDBClusterIdentifier" + } + } + }, + "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaDBInstanceIdentifier" + } + } + }, + "com.amazonaws.rds#ReadReplicaIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaIdentifier" + } + } + }, + "com.amazonaws.rds#ReadersArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#RebootDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RebootDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#RebootDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.

\n

Rebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

\n

Use this operation only for a non-Aurora Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

" + } + }, + "com.amazonaws.rds#RebootDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RebootDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RebootDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RebootDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#RebootDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.

\n

Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

\n

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

\n

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

", + "smithy.api#examples": [ + { + "title": "To reboot a DB instance", + "documentation": "The following example starts a reboot of the specified DB instance.", "input": { - "target": "com.amazonaws.rds#StartDBClusterMessage" + "DBInstanceIdentifier": "test-mysql-instance" }, "output": { - "target": "com.amazonaws.rds#StartDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "rebooting", + "MasterUsername": "admin", + "Endpoint": { + "Address": "test-mysql-instance.############.us-west-2.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z1PVIF0EXAMPLE" } - ], - "traits": { - "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To start a DB cluster", - "documentation": "The following example starts a DB cluster and its DB instances.", - "input": { - "DBClusterIdentifier": "mydbcluster" - }, - "output": { - "DBCluster": { - "AllocatedStorage": 1, - "AvailabilityZones": [ - "us-east-1a", - "us-east-1e", - "us-east-1b" - ], - "BackupRetentionPeriod": 1, - "DatabaseName": "mydb", - "DBClusterIdentifier": "mydbcluster" - } - } - } - ] + } } + } + ] + } + }, + "com.amazonaws.rds#RebootDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBInstance.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ForceFailover": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RebootDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RecurringCharge": { + "type": "structure", + "members": { + "RecurringChargeAmount": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of the recurring charge.

" + } + }, + "RecurringChargeFrequency": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The frequency of the recurring charge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" + } + }, + "com.amazonaws.rds#RecurringChargeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#RecurringCharge", + "traits": { + "smithy.api#xmlName": "RecurringCharge" + } + } + }, + "com.amazonaws.rds#RegisterDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RegisterDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#RegisterDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, - "com.amazonaws.rds#StartDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as\n a lowercase string.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, - "com.amazonaws.rds#StartDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" }, - "com.amazonaws.rds#StartDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StartDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#StartDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

\n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

\n ", - "smithy.api#examples": [ - { - "title": "To start a DB instance", - "documentation": "The following example starts the specified DB instance.", - "input": { - "DBInstanceIdentifier": "test-instance" - }, - "output": { - "DBInstance": { - "DBInstanceStatus": "starting" - } - } - } - ] - } + { + "target": "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, - "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication": { - "type": "operation", + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#RegisterDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" + } + }, + "DBInstanceIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB instance identifiers.

" + } + }, + "DBClusterIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB cluster identifiers.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RegisterDBProxyTargetsResponse": { + "type": "structure", + "members": { + "DBProxyTargets": { + "target": "com.amazonaws.rds#TargetList", + "traits": { + "smithy.api#documentation": "

One or more DBProxyTarget objects that are created when you register targets with a target group.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RemoveFromGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveFromGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#RemoveFromGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To detach an Aurora secondary cluster from an Aurora global database cluster", + "documentation": "The following example detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster changes from being read-only to a standalone cluster with read-write capability.", "input": { - "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage" + "GlobalClusterIdentifier": "myglobalcluster", + "DbClusterIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" }, "output": { - "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Enables replication of automated backups to a different Amazon Web Services Region.

\n

This command doesn't apply to RDS Custom.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

", - "smithy.api#examples": [ - { - "title": "To enable cross-Region automated backups", - "documentation": "The following example replicates automated backups from a DB instance in the US East (N. Virginia) Region. The backup retention period is 14 days.", - "input": { - "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", - "BackupRetentionPeriod": 14 - }, - "output": { - "DBInstanceAutomatedBackup": { - "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", - "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", - "Region": "us-east-1", - "DBInstanceIdentifier": "new-orcl-db", - "RestoreWindow": {}, - "AllocatedStorage": 20, - "Status": "pending", - "Port": 1521, - "InstanceCreateTime": "2020-12-04T15:28:31Z", - "MasterUsername": "admin", - "Engine": "oracle-se2", - "EngineVersion": "12.1.0.2.v21", - "LicenseModel": "bring-your-own-license", - "OptionGroupName": "default:oracle-se2-12-1", - "Encrypted": false, - "StorageType": "gp2", - "IAMDatabaseAuthenticationEnabled": false, - "BackupRetentionPeriod": 14, - "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" - } - } - } + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-abc123def456gh", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-postgresql", + "EngineVersion": "10.11", + "StorageEncrypted": true, + "DeletionProtection": false, + "GlobalClusterMembers": [ + { + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster", + "Readers": ["arn:aws:rds:us-west-2:123456789012:cluster:DB-1"], + "IsWriter": true + }, + { + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1", + "Readers": [], + "IsWriter": false, + "GlobalWriteForwardingStatus": "disabled" + } ] + } } - }, - "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { - "type": "structure", - "members": { - "SourceDBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", - "smithy.api#required": {} - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The retention period for the replicated automated backups.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\n Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, \n arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult": { - "type": "structure", - "members": { - "DBInstanceAutomatedBackup": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.rds#StartDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} + } + ] + } + }, + "com.amazonaws.rds#RemoveFromGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier to detach from the Aurora global database cluster.

" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RemoveFromGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RemoveRoleFromDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveRoleFromDBClusterMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To disassociate an Identity and Access Management (IAM) role from a DB cluster", + "documentation": "The following example removes a role from a DB cluster.", + "input": { + "DBClusterIdentifier": "mydbcluster", + "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3" } - }, - "com.amazonaws.rds#StartDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } + } + ] + } + }, + "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster to disassociate the IAM role from.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example\n arn:aws:iam::123456789012:role/AuroraAccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RemoveRoleFromDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

" + } + }, + "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB instance to disassociate the IAM role from.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance,\n for example, arn:aws:iam::123456789012:role/AccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a source identifier from an existing RDS event notification subscription.

", + "smithy.api#examples": [ + { + "title": "To remove a source identifier from a subscription", + "documentation": "The following example removes the specified source identifier from an existing subscription.", + "input": { + "SubscriptionName": "my-instance-events", + "SourceIdentifier": "test-instance-repl" }, - "traits": { - "smithy.api#output": {} + "output": { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": ["backup", "recovery"], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "modifying", + "CustSubscriptionId": "my-instance-events", + "CustomerAwsId": "123456789012", + "SourceIdsList": ["test-instance"], + "SourceType": "db-instance", + "Enabled": false + } + } + } + ] + } + }, + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to remove a source identifier from.

", + "smithy.api#required": {} + } + }, + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RemoveTagsFromResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveTagsFromResourceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes metadata tags from an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n

", + "smithy.api#examples": [ + { + "title": "To remove tags from a resource", + "documentation": "The following example removes tags from a resource.", + "input": { + "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:mydbinstance", + "TagKeys": ["Name", "Environment"] } - }, - "com.amazonaws.rds#StartExportTask": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.rds#RemoveTagsFromResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.rds#KeyList", + "traits": { + "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ReplicaMode": { + "type": "enum", + "members": { + "OPEN_READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open-read-only" + } + }, + "MOUNTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mounted" + } + } + } + }, + "com.amazonaws.rds#ReservedDBInstance": { + "type": "structure", + "members": { + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the reservation.

" + } + }, + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" + } + }, + "StartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time the reservation started.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the reservation in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The fixed price charged for this reserved DB instance.

" + } + }, + "UsagePrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The hourly price charged for this reserved DB instance.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The currency code for the reserved DB instance.

" + } + }, + "DBInstanceCount": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of reserved DB instances.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the reserved DB instance.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type of this reserved DB instance.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the reservation applies to Multi-AZ deployments.

" + } + }, + "State": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The state of the reserved DB instance.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.rds#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" + } + }, + "ReservedDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the reserved DB instance.

" + } + }, + "LeaseId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.

" + } + }, + "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceAlreadyExists", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

User already has a reservation with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ReservedDBInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ReservedDBInstance", + "traits": { + "smithy.api#xmlName": "ReservedDBInstance" + } + } + }, + "com.amazonaws.rds#ReservedDBInstanceMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "ReservedDBInstances": { + "target": "com.amazonaws.rds#ReservedDBInstanceList", + "traits": { + "smithy.api#documentation": "

A list of reserved DB instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ReservedDBInstanceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified reserved DB Instance not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Request would exceed the user's DB Instance quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ReservedDBInstancesOffering": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the offering in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The fixed price charged for this offering.

" + } + }, + "UsagePrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The hourly price charged for this offering.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The currency code for the reserved DB instance offering.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine used by the offering.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the offering applies to Multi-AZ deployments.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.rds#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" + } + }, + "com.amazonaws.rds#ReservedDBInstancesOfferingList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ReservedDBInstancesOffering", + "traits": { + "smithy.api#xmlName": "ReservedDBInstancesOffering" + } + } + }, + "com.amazonaws.rds#ReservedDBInstancesOfferingMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "ReservedDBInstancesOfferings": { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingList", + "traits": { + "smithy.api#documentation": "

A list of reserved DB instance offerings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstancesOfferingNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

Specified offering does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ResetDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ResetDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.

\n

When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To reset all parameters to their default values", + "documentation": "The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.", "input": { - "target": "com.amazonaws.rds#StartExportTaskMessage" + "DBClusterParameterGroupName": "mydbclpg", + "ResetAllParameters": true }, "output": { - "target": "com.amazonaws.rds#ExportTask" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#ExportTaskAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#IamRoleMissingPermissionsFault" - }, - { - "target": "com.amazonaws.rds#IamRoleNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidExportOnlyFault" - }, - { - "target": "com.amazonaws.rds#InvalidExportSourceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidS3BucketFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

\n

You can't export snapshot data from RDS Custom DB instances.

\n

You can't export cluster data from Multi-AZ DB clusters.

\n

For more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

\n

For more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.

", - "smithy.api#examples": [ - { - "title": "To export a snapshot to Amazon S3", - "documentation": "The following example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.", - "input": { - "ExportTaskIdentifier": "my-s3-export", - "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", - "S3BucketName": "mybucket", - "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", - "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff" - }, - "output": { - "ExportTaskIdentifier": "my-s3-export", - "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", - "SnapshotTime": "2020-03-27T20:48:42.023Z", - "S3Bucket": "mybucket", - "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", - "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", - "Status": "STARTING", - "PercentProgress": 0, - "TotalExtractedDataInGB": 0 - } - } - ] - } - }, - "com.amazonaws.rds#StartExportTaskMessage": { - "type": "structure", - "members": { - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A unique identifier for the export task. This ID isn't an identifier for\n the Amazon S3 bucket where the data is to be exported.

", - "smithy.api#required": {} - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

", - "smithy.api#required": {} - } - }, - "S3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

", - "smithy.api#required": {} - } - }, - "IamRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot or cluster.

\n

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon\n RDS or Amazon Aurora to an S3 bucket:

\n
    \n
  • \n

    s3:PutObject*

    \n
    • \n
  • \n

    s3:GetObject*

    \n
    • \n
  • \n

    s3:ListBucket

    \n
    • \n
  • \n

    s3:DeleteObject*

    \n
    • \n
  • \n

    s3:GetBucketLocation

    \n
    • \n
\n

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows\n the Amazon Resource Name (ARN) format for accessing S3:

\n
    \n
  • \n

    \n arn:aws:s3:::your-s3-bucket\n \n

    \n
    • \n
  • \n

    \n arn:aws:s3:::your-s3-bucket/*\n

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to run the following operations. \n These can be set in the Amazon Web Services KMS key policy:

\n
    \n
  • \n

    kms:Encrypt

    \n
    • \n
  • \n

    kms:Decrypt

    \n
    • \n
  • \n

    kms:GenerateDataKey

    \n
    • \n
  • \n

    kms:GenerateDataKeyWithoutPlaintext

    \n
    • \n
  • \n

    kms:ReEncryptFrom

    \n
    • \n
  • \n

    kms:ReEncryptTo

    \n
    • \n
  • \n

    kms:CreateGrant

    \n
    • \n
  • \n

    kms:DescribeKey

    \n
    • \n
  • \n

    kms:RetireGrant

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "S3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket prefix to use as the file name and path of the exported data.

" - } - }, - "ExportOnly": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The data to be exported from the snapshot or cluster. \n If this parameter is not provided, all of the data is exported.\n Valid values are the following:

\n
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#input": {} + "DBClusterParameterGroupName": "mydbclpg" } - }, - "com.amazonaws.rds#StopActivityStream": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to reset.

", + "smithy.api#required": {} + } + }, + "ResetAllParameters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this\n parameter if the ResetAllParameters parameter is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ResetDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ResetDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

", + "smithy.api#examples": [ + { + "title": "To reset all parameters to their default values", + "documentation": "The following example resets all parameter values in a customer-created DB parameter group to their default values.", "input": { - "target": "com.amazonaws.rds#StopActivityStreamRequest" + "DBParameterGroupName": "mypg", + "ResetAllParameters": true }, "output": { - "target": "com.amazonaws.rds#StopActivityStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

\n

For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

", - "smithy.api#examples": [ - { - "title": "To stop a database activity stream", - "documentation": "The following example stops an activity stream in an Aurora cluster named my-pg-cluster.", - "input": { - "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", - "ApplyImmediately": true - }, - "output": { - "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", - "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", - "Status": "stopping" - } - } - ] + "DBParameterGroupName": "mypg" } + } + ] + } + }, + "com.amazonaws.rds#ResetDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n
    \n
  • \n

    Must match the name of an existing DBParameterGroup.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ResetAllParameters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

\n

\n MySQL\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n MariaDB\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n Oracle\n

\n

Valid Values (for Apply method): pending-reboot\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#ResourceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified resource ID was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ResourcePendingMaintenanceActions": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that has pending maintenance actions.

" + } + }, + "PendingMaintenanceActionDetails": { + "target": "com.amazonaws.rds#PendingMaintenanceActionDetails", + "traits": { + "smithy.api#documentation": "

A list that provides details about the pending maintenance actions for the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the pending maintenance actions for a resource.

" + } + }, + "com.amazonaws.rds#RestoreDBClusterFromS3": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3Message" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3Result" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" }, - "com.amazonaws.rds#StopActivityStreamRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", - "smithy.api#required": {} - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, - "com.amazonaws.rds#StopActivityStreamResponse": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "KinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" }, - "com.amazonaws.rds#StopDBCluster": { - "type": "operation", + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

\n ", + "smithy.api#examples": [ + { + "title": "To restore an Amazon Aurora DB cluster from Amazon S3", + "documentation": "The following example restores an Amazon Aurora MySQL version 5.7-compatible DB cluster from a MySQL 5.7 DB backup file in Amazon S3.", "input": { - "target": "com.amazonaws.rds#StopDBClusterMessage" + "DBClusterIdentifier": "cluster-s3-restore", + "Engine": "aurora-mysql", + "MasterUsername": "admin", + "MasterUserPassword": "mypassword", + "SourceEngine": "mysql", + "SourceEngineVersion": "5.7.28", + "S3BucketName": "mybucket", + "S3Prefix": "test-backup", + "S3IngestionRoleArn": "arn:aws:iam::123456789012:role/service-role/TestBackup" }, "output": { - "target": "com.amazonaws.rds#StopDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#examples": [ - { - "title": "To stop a DB cluster", - "documentation": "The following example stops a DB cluster and its DB instances.", - "input": { - "DBClusterIdentifier": "mydbcluster" - }, - "output": { - "DBCluster": { - "AllocatedStorage": 1, - "AvailabilityZones": [ - "us-east-1a", - "us-east-1e", - "us-east-1b" - ], - "BackupRetentionPeriod": 1, - "DatabaseName": "mydb", - "DBClusterIdentifier": "mydbcluster" - } - } - } - ] - } + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": ["us-west-2c", "us-west-2a", "us-west-2b"], + "BackupRetentionPeriod": 1, + "DBClusterIdentifier": "cluster-s3-restore", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.12", + "Port": 3306, + "MasterUsername": "admin", + "PreferredBackupWindow": "11:15-11:45", + "PreferredMaintenanceWindow": "thu:12:19-thu:12:49", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": false, + "DbClusterResourceId": "cluster-SU5THYQQHOWCXZZDGXREXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-07-27T14:22:08.095Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBClusterFromS3Message": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n
    \n
  • \n

    Must be a value from 1 to 35

    \n
    • \n
" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB cluster.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBClusterParameterGroup.

    \n
    • \n
" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the restored DB cluster.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with the restored DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora-mysql (for Aurora MySQL)

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Examples: 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0\n

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the instances in the restored DB cluster accept connections.

\n

Default: 3306\n

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the master user for the restored DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n
    \n
  • \n

    Must contain from 8 to 41 characters.

    \n
    • \n
  • \n

    Can't be specified if ManageMasterUserPassword is turned on.

    \n
    • \n
" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

\n

Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the restored DB cluster is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

" + } + }, + "SourceEngine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.

\n

Valid values: mysql\n

", + "smithy.api#required": {} + } + }, + "SourceEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.5, 5.6, and 5.7 are supported.

\n

Example: 5.6.40, 5.7.28\n

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.\n If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is\n created by using all of the files in the Amazon S3 bucket.

" + } + }, + "S3IngestionRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

", + "smithy.api#required": {} + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid values: aurora, aurora-iopt1\n

\n

Default: aurora\n

\n

Valid for: Aurora DB clusters only

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterFromS3Result": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" }, - "com.amazonaws.rds#StopDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as\n a lowercase string.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" }, - "com.amazonaws.rds#StopDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" }, - "com.amazonaws.rds#StopDBInstance": { - "type": "operation", + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To restore a DB cluster from a snapshot", + "documentation": "The following example restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named test-instance-snapshot.", "input": { - "target": "com.amazonaws.rds#StopDBInstanceMessage" + "DBClusterIdentifier": "newdbcluster", + "SnapshotIdentifier": "test-instance-snapshot", + "Engine": "aurora-postgresql", + "EngineVersion": "10.7" }, "output": { - "target": "com.amazonaws.rds#StopDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.

\n

For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.

\n ", - "smithy.api#examples": [ - { - "title": "To stop a DB instance", - "documentation": "The following example stops the specified DB instance.", - "input": { - "DBInstanceIdentifier": "test-instance" - }, - "output": { - "DBInstance": { - "DBInstanceStatus": "stopping" - } - } - } - ] - } + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": ["us-west-2c", "us-west-2a", "us-west-2b"], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "newdbcluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-06-05T15:06:58.634Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "SnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Snapshot.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for the new DB cluster.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version\n for the database engine in the Amazon Web Services Region is used.

\n

To list all of the available engine versions for Aurora MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See Database \n engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

See Amazon \n Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

\n

\n MySQL\n

\n

See Amazon \n RDS for MySQL in the Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon \n RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: This value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DB subnet group.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to use for the restored DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n
    \n
  • \n

    If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.

    \n
    • \n
  • \n

    If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
\n

Valid for: Aurora DB clusters only

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned or serverless.

\n

For more information, see \n CreateDBCluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing default DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, - "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication": { - "type": "operation", + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.\n

", + "smithy.api#examples": [ + { + "title": "To restore a DB cluster to a specified time", + "documentation": "The following example restores the DB cluster named database-4 to the latest possible time. Using copy-on-write as the restore type restores the new DB cluster as a clone of the source DB cluster.", "input": { - "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage" + "DBClusterIdentifier": "sample-cluster-clone", + "RestoreType": "copy-on-write", + "SourceDBClusterIdentifier": "database-4", + "UseLatestRestorableTime": true }, "output": { - "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

", - "smithy.api#examples": [ - { - "title": "To stop replicating automated backups", - "documentation": "The following example ends replication of automated backups. Replicated backups are retained according to the set backup retention period.", - "input": { - "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" - }, - "output": { - "DBInstanceAutomatedBackup": { - "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", - "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", - "Region": "us-east-1", - "DBInstanceIdentifier": "new-orcl-db", - "RestoreWindow": { - "EarliestTime": "2020-12-04T23:13:21.030Z", - "LatestTime": "2020-12-07T19:59:57Z" - }, - "AllocatedStorage": 20, - "Status": "replicating", - "Port": 1521, - "InstanceCreateTime": "2020-12-04T15:28:31Z", - "MasterUsername": "admin", - "Engine": "oracle-se2", - "EngineVersion": "12.1.0.2.v21", - "LicenseModel": "bring-your-own-license", - "OptionGroupName": "default:oracle-se2-12-1", - "Encrypted": false, - "StorageType": "gp2", - "IAMDatabaseAuthenticationEnabled": false, - "BackupRetentionPeriod": 7, - "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" - } - } - } - ] - } + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": ["us-west-2c", "us-west-2a", "us-west-2b"], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "sample-cluster-clone", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd", + "ClusterCreateTime": "2020-03-10T19:57:38.967Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the new DB cluster to be created.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "RestoreType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n
    \n
  • \n

    \n full-copy - The new DB cluster is restored as a full copy of the\n source DB cluster.

    \n
    • \n
  • \n

    \n copy-on-write - The new DB cluster is restored as a clone of the\n source DB cluster.

    \n
    • \n
\n

If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBCluster.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "RestoreToTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time to restore the DB cluster to.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n
    \n
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Must be specified if UseLatestRestorableTime parameter isn't provided

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \n
  • \n

    Can't be specified if the RestoreType parameter is copy-on-write\n

    \n
    • \n
\n

Example: 2015-03-07T23:45:00Z\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: A value from 1150-65535.

\n

Default: The default port for the engine.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group for the new DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n
    \n
  • \n

    If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

    \n
    • \n
  • \n

    If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

    \n
    • \n
\n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n
    \n
  • \n

    If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    \n
    • \n
\n

Valid for: Aurora MySQL DB clusters only

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DB cluster parameter group.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

\n

Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

    \n
    • \n
\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } + }, + "SourceDbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the source DB cluster from which to restore.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, - "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { - "type": "structure", - "members": { - "SourceDBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating\n automate backups, for example,\n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, - "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult": { - "type": "structure", - "members": { - "DBInstanceAutomatedBackup": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" }, - "com.amazonaws.rds#StopDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier.

", - "smithy.api#required": {} - } - }, - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, - "com.amazonaws.rds#StopDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, - "com.amazonaws.rds#StorageQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n ", + "smithy.api#examples": [ + { + "title": "To restore a DB instance from a DB snapshot", + "documentation": "The following example creates a new DB instance named db7-new-instance with the db.t3.small DB instance class from the specified DB snapshot. The source DB instance from which the snapshot was taken uses a deprecated DB instance class, so you can't upgrade it.", + "input": { + "DBInstanceIdentifier": "db7-new-instance", + "DBSnapshotIdentifier": "db7-test-snapshot", + "DBInstanceClass": "db.t3.small" }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StorageQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed amount of storage\n available across all DB instances.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + "output": { + "DBInstance": { + "DBInstanceIdentifier": "db7-new-instance", + "DBInstanceClass": "db.t3.small", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "PreferredMaintenanceWindow": "mon:07:37-mon:08:07", + "PendingModifiedValues": {}, + "MultiAZ": false, + "EngineVersion": "5.7.22", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false, + "DeletionProtection": false, + "AssociatedRoles": [] + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 numbers, letters, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-snapshot-id\n

", + "smithy.api#required": {} + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DBSnapshot.

    \n
    • \n
  • \n

    Can't be specified when DBClusterSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBClusterSnapshotIdentifier isn't specified.

    \n
    • \n
  • \n

    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

    \n
    • \n
" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Default: The same port as the original DB instance

\n

Constraints: Value must be 1150-65535\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

\n

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

\n

Constraints: Must be an integer greater than 1000.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Constraints:

\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.

\n

For more information on Multi-AZ DB clusters, see Multi-AZ DB\n cluster deployments in the Amazon RDS User\n Guide.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Multi-AZ DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be specified when DBSnapshotIdentifier is specified.

    \n
    • \n
  • \n

    Must be specified when DBSnapshotIdentifier isn't specified.

    \n
    • \n
  • \n

    If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier\n must be the ARN of the shared snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an Aurora DB cluster snapshot.

    \n
    • \n
  • \n

    Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.

    \n
    • \n
" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromS3": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Message" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Result" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, - "com.amazonaws.rds#StorageTypeNotAvailableFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StorageTypeNotAvailableFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The aurora-iopt1 storage type isn't available, because you modified the DB cluster \n to use this storage type less than one month ago.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, - "com.amazonaws.rds#StorageTypeNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StorageTypeNotSupported", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified StorageType can't be associated with the DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, - "com.amazonaws.rds#String": { - "type": "string" + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, - "com.amazonaws.rds#String255": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": ".*" - } + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, - "com.amazonaws.rds#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, - "com.amazonaws.rds#Subnet": { - "type": "structure", - "members": { - "SubnetIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the subnet.

" - } - }, - "SubnetAvailabilityZone": { - "target": "com.amazonaws.rds#AvailabilityZone" - }, - "SubnetOutpost": { - "target": "com.amazonaws.rds#Outpost", - "traits": { - "smithy.api#documentation": "

If the subnet is associated with an Outpost, this value specifies the Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" - } - }, - "SubnetStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the subnet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element for the DescribeDBSubnetGroups operation.

" - } + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, - "com.amazonaws.rds#SubnetAlreadyInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SubnetAlreadyInUse", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB subnet is already in use in the Availability Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, - "com.amazonaws.rds#SubnetIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "SubnetIdentifier" - } - } + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, - "com.amazonaws.rds#SubnetList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Subnet", - "traits": { - "smithy.api#xmlName": "Subnet" - } - } + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" }, - "com.amazonaws.rds#SubscriptionAlreadyExistFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SubscriptionAlreadyExist", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The supplied subscription name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + { + "target": "com.amazonaws.rds#InvalidSubnet" }, - "com.amazonaws.rds#SubscriptionCategoryNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SubscriptionCategoryNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The supplied category does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, - "com.amazonaws.rds#SubscriptionNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SubscriptionNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The subscription name does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, - "com.amazonaws.rds#SupportedCharacterSetsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#CharacterSet", - "traits": { - "smithy.api#xmlName": "CharacterSet" - } - } + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" }, - "com.amazonaws.rds#SupportedTimezonesList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Timezone", - "traits": { - "smithy.api#xmlName": "Timezone" - } - } + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, - "com.amazonaws.rds#SwitchoverBlueGreenDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Switches over a blue/green deployment.

\n

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

\n

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

" - } + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" }, - "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest": { - "type": "structure", - "members": { - "BlueGreenDeploymentIdentifier": { - "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "SwitchoverTimeout": { - "target": "com.amazonaws.rds#SwitchoverTimeout", - "traits": { - "smithy.api#documentation": "

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

\n

Default: 300

\n

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

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, - "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse": { - "type": "structure", - "members": { - "BlueGreenDeployment": { - "target": "com.amazonaws.rds#BlueGreenDeployment" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

" + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { + "type": "structure", + "members": { + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
\n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.

\n " + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid Values: \n mysql\n

", + "smithy.api#required": {} + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the master user.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 16 letters or numbers.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't be a reserved word for the chosen database engine.

    \n
    • \n
" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups to associate with this DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    \n
    • \n
  • \n

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred backup window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Must be in the format hh24:mi-hh24:mi.

    \n
    • \n
  • \n

    Must be in Universal Coordinated Time (UTC).

    \n
    • \n
  • \n

    Must not conflict with the preferred maintenance window.

    \n
    • \n
  • \n

    Must be at least 30 minutes.

    \n
    • \n
" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Type: Integer

\n

Valid Values: 1150-65535\n

\n

Default: 3306\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for this DB instance.\n Use general-public-license.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, \n you must also include a value for the Iops parameter.

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the new DB instance is encrypted or not.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + } + }, + "SourceEngine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the engine of your source database.

\n

Valid Values: \n mysql\n

", + "smithy.api#required": {} + } + }, + "SourceEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.6 and 5.7 are supported.

\n

Example: 5.6.40\n

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of your Amazon S3 bucket \n that contains your database backup file.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The prefix of your Amazon S3 bucket.

" + } + }, + "S3IngestionRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n
    \n
  • \n

    7

    \n
    • \n
  • \n

    \n month * 31, where month is a number of months from 1-23

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

For example, the following values are valid:

\n
    \n
  • \n

    93 (3 months * 31)

    \n
    • \n
  • \n

    341 (11 months * 31)

    \n
    • \n
  • \n

    589 (19 months * 31)

    \n
    • \n
  • \n

    731

    \n
    • \n
\n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n
    \n
  • \n

    Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword \n is specified.

    \n
    • \n
" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceFromS3Result": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, - "com.amazonaws.rds#SwitchoverDetail": { - "type": "structure", - "members": { - "SourceMember": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the blue environment.

" - } - }, - "TargetMember": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the green environment.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#SwitchoverDetailStatus", - "traits": { - "smithy.api#documentation": "

The switchover status of a resource in a blue/green deployment.

\n

Values:

\n
    \n
  • \n

    \n PROVISIONING - The resource is being prepared to switch\n over.

    \n
    • \n
  • \n

    \n AVAILABLE - The resource is ready to switch over.

    \n
    • \n
  • \n

    \n SWITCHOVER_IN_PROGRESS - The resource is being switched\n over.

    \n
    • \n
  • \n

    \n SWITCHOVER_COMPLETED - The resource has been switched\n over.

    \n
    • \n
  • \n

    \n SWITCHOVER_FAILED - The resource attempted to switch over but\n failed.

    \n
    • \n
  • \n

    \n MISSING_SOURCE - The source resource has been deleted.

    \n
    • \n
  • \n

    \n MISSING_TARGET - The target resource has been deleted.

    \n
    • \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

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

" - } + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" }, - "com.amazonaws.rds#SwitchoverDetailList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#SwitchoverDetail" - } + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" }, - "com.amazonaws.rds#SwitchoverDetailStatus": { - "type": "string" + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" }, - "com.amazonaws.rds#SwitchoverReadReplica": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#SwitchoverReadReplicaMessage" - }, - "output": { - "target": "com.amazonaws.rds#SwitchoverReadReplicaResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new\n primary database. Issue this command in the Region that hosts the current standby database.

" - } + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, - "com.amazonaws.rds#SwitchoverReadReplicaMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Oracle read replica DB instance.

    \n
    • \n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" }, - "com.amazonaws.rds#SwitchoverReadReplicaResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" }, - "com.amazonaws.rds#SwitchoverTimeout": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 30 - } - } + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, - "com.amazonaws.rds#TStamp": { - "type": "timestamp" + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, - "com.amazonaws.rds#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" - } - }, - "Value": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n

" - } + { + "target": "com.amazonaws.rds#DomainNotFoundFault" }, - "com.amazonaws.rds#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Tag", - "traits": { - "smithy.api#xmlName": "Tag" - } - }, - "traits": { - "smithy.api#documentation": "

A list of tags.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" - } + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" }, - "com.amazonaws.rds#TagListMessage": { - "type": "structure", - "members": { - "TagList": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#output": {} - } + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, - "com.amazonaws.rds#TargetDBClusterParameterGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" - } + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, - "com.amazonaws.rds#TargetDBParameterGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" - } + { + "target": "com.amazonaws.rds#InvalidRestoreFault" }, - "com.amazonaws.rds#TargetEngineVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9A-Za-z-_.]+$" - } + { + "target": "com.amazonaws.rds#InvalidSubnet" }, - "com.amazonaws.rds#TargetGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBProxyTargetGroup" - } + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" }, - "com.amazonaws.rds#TargetHealth": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.rds#TargetState", - "traits": { - "smithy.api#documentation": "

The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:

\n

\n registering > unavailable > available > unavailable > available\n

" - } - }, - "Reason": { - "target": "com.amazonaws.rds#TargetHealthReason", - "traits": { - "smithy.api#documentation": "

The reason for the current health State of the RDS Proxy target.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A description of the health of the RDS Proxy target. \n If the State is AVAILABLE, a description is not included.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the connection health of an RDS Proxy target.

" - } + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, - "com.amazonaws.rds#TargetHealthReason": { - "type": "enum", - "members": { - "UNREACHABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNREACHABLE" - } - }, - "CONNECTION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTION_FAILED" - } - }, - "AUTH_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTH_FAILURE" - } - }, - "PENDING_PROXY_CAPACITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_PROXY_CAPACITY" - } - }, - "INVALID_REPLICATION_STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_REPLICATION_STATE" - } - } - } + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" }, - "com.amazonaws.rds#TargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBProxyTarget" - } + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, - "com.amazonaws.rds#TargetRole": { - "type": "enum", - "members": { - "READ_WRITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ_WRITE" - } - }, - "READ_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ_ONLY" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - } - } + { + "target": "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault" }, - "com.amazonaws.rds#TargetState": { - "type": "enum", - "members": { - "registering": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGISTERING" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "unavailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNAVAILABLE" - } - } - } + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" }, - "com.amazonaws.rds#TargetType": { - "type": "enum", - "members": { - "RDS_INSTANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_INSTANCE" - } - }, - "RDS_SERVERLESS_ENDPOINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_SERVERLESS_ENDPOINT" - } - }, - "TRACKED_CLUSTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRACKED_CLUSTER" - } - } - } + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" }, - "com.amazonaws.rds#Timezone": { - "type": "structure", - "members": { - "TimezoneName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the time zone.

" - } - } + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n ", + "smithy.api#examples": [ + { + "title": "To restore a DB instance to a point in time", + "documentation": "The following example restores test-instance to a new DB instance named restored-test-instance, as of the specified time.", + "input": { + "SourceDBInstanceIdentifier": "test-instance", + "TargetDBInstanceIdentifier": "restored-test-instance", + "RestoreTime": "2018-07-30T23:45:00.000Z" }, - "traits": { - "smithy.api#documentation": "

A time zone associated with a \n DBInstance \n or a DBSnapshot.\n This data type is an element in the response to \n the DescribeDBInstances, \n the DescribeDBSnapshots,\n and the DescribeDBEngineVersions\n actions.

" - } - }, - "com.amazonaws.rds#UpgradeTarget": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the upgrade target database engine.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the upgrade target database engine.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" - } - }, - "AutoUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" - } - }, - "IsMajorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

" - } - }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", - "traits": { - "smithy.api#documentation": "

A list of the supported DB engine modes for the target engine version.

" - } - }, - "SupportsParallelQuery": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with the target engine version.

" - } - }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with the target engine version.

" - } - }, - "SupportsBabelfish": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

" - } - }, - "SupportsLocalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" - } - } + "output": { + "DBInstance": { + "PubliclyAccessible": true, + "MasterUsername": "mymasteruser", + "MonitoringInterval": 0, + "LicenseModel": "general-public-license", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-e5e5b0d2" + } + ], + "CopyTagsToSnapshot": false, + "OptionGroupMemberships": [ + { + "Status": "in-sync", + "OptionGroupName": "default:mysql-5-6" + } + ], + "PendingModifiedValues": {}, + "Engine": "mysql", + "MultiAZ": false, + "DBSecurityGroups": [], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.6", + "ParameterApplyStatus": "in-sync" + } + ], + "AutoMinorVersionUpgrade": true, + "PreferredBackupWindow": "12:58-13:28", + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-77e8db03", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-c39989a1", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4b267b0d", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + } + ], + "DBSubnetGroupName": "default", + "VpcId": "vpc-c1c5b3a3", + "DBSubnetGroupDescription": "default", + "SubnetGroupStatus": "Complete" + }, + "ReadReplicaDBInstanceIdentifiers": [], + "AllocatedStorage": 200, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:restored-test-instance", + "BackupRetentionPeriod": 7, + "DBName": "sample", + "PreferredMaintenanceWindow": "tue:10:16-tue:10:46", + "DBInstanceStatus": "available", + "EngineVersion": "5.6.27", + "AvailabilityZone": "us-west-2b", + "DomainMemberships": [], + "StorageType": "gp2", + "DbiResourceId": "db-VNZUCCBTEDC4WR7THXNJO72HVQ", + "CACertificateIdentifier": "rds-ca-2015", + "StorageEncrypted": false, + "DBInstanceClass": "db.t2.small", + "DbInstancePort": 0, + "DBInstanceIdentifier": "restored-test-instance" + } + } + } + ] + } + }, + "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage": { + "type": "structure", + "members": { + "SourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB instance from which to restore.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing DB instance.

    \n
    • \n
" + } + }, + "TargetDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the new DB instance to be created.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "RestoreTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time to restore from.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n
    \n
  • \n

    Must be before the latest restorable time for the DB instance

    \n
    • \n
  • \n

    Can't be specified if the UseLatestRestorableTime parameter is enabled

    \n
    • \n
\n

Example: 2009-09-07T23:45:00Z\n

" + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.

\n

Constraints: Can't be specified if the RestoreTime parameter is provided.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: The same DBInstanceClass as the original DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB instance.

\n \n

This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

\n " + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid Values:

\n
    \n
  • \n

    \n mariadb\n

    \n
    • \n
  • \n

    \n mysql\n

    \n
    • \n
  • \n

    \n oracle-ee\n

    \n
    • \n
  • \n

    \n oracle-ee-cdb\n

    \n
    • \n
  • \n

    \n oracle-se2\n

    \n
    • \n
  • \n

    \n oracle-se2-cdb\n

    \n
    • \n
  • \n

    \n postgres\n

    \n
    • \n
  • \n

    \n sqlserver-ee\n

    \n
    • \n
  • \n

    \n sqlserver-se\n

    \n
    • \n
  • \n

    \n sqlserver-ex\n

    \n
    • \n
  • \n

    \n sqlserver-web\n

    \n
    • \n
" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

\n

Constraints: Must be an integer greater than 1000.

\n

\n SQL Server\n

\n

Setting the IOPS value for the SQL Server database engine isn't supported.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom DB instances.

" + } + }, + "DomainFqdn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of an Active Directory domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: mymanagedADtest.mymanagedAD.mydomain\n

" + } + }, + "DomainOu": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory organizational unit for your DB instance to join.

\n

Constraints:

\n
    \n
  • \n

    Must be in the distinguished name format.

    \n
    • \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain\n

" + } + }, + "DomainAuthSecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 64 characters.

    \n
    • \n
\n

Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456\n

" + } + }, + "DomainDnsIps": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

\n

Constraints:

\n
    \n
  • \n

    Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

    \n
    • \n
\n

Example: 123.124.125.126,234.235.236.237\n

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match the name of an existing DBParameterGroup.

    \n
    • \n
  • \n

    Must be 1 to 255 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    First character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "SourceDbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the source DB instance from which to restore.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "SourceDBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n
    \n
  • \n

    The profile must exist in your account.

    \n
    • \n
  • \n

    The profile must have an IAM role that Amazon EC2 has permissions to assume.

    \n
    • \n
  • \n

    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

    \n
    • \n
\n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n
    \n
  • \n

    \n IPV4\n

    \n
    • \n
  • \n

    \n DUAL\n

    \n
    • \n
\n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#RestoreWindow": { + "type": "structure", + "members": { + "EarliestTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time you can restore an instance to.

" + } + }, + "LatestTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The latest time you can restore an instance to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Earliest and latest time an instance can be restored to:

" + } + }, + "com.amazonaws.rds#RevokeDBSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage" + }, + "output": { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – \n Here’s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To revoke ingress for a DB security group", + "documentation": "This example revokes ingress for the specified CIDR block associated with the specified DB security group.", + "input": { + "DBSecurityGroupName": "mydbsecuritygroup", + "CIDRIP": "203.0.113.5/32" }, - "traits": { - "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" + "output": { + "DBSecurityGroup": {} } - }, - "com.amazonaws.rds#UserAuthConfig": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" - } - }, - "UserName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" - } - }, - "AuthScheme": { - "target": "com.amazonaws.rds#AuthScheme", - "traits": { - "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" - } - }, - "IAMAuth": { - "target": "com.amazonaws.rds#IAMAuthMode", - "traits": { - "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" - } - }, - "ClientPasswordAuthType": { - "target": "com.amazonaws.rds#ClientPasswordAuthType", - "traits": { - "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" - } - } + } + ] + } + }, + "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to revoke ingress from.

", + "smithy.api#required": {} + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n can't be provided.

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SNSInvalidTopicFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSInvalidTopic", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

SNS has responded that there is a problem with the SNS topic specified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SNSNoAuthorizationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSNoAuthorization", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You do not have permission to publish to the SNS topic ARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SNSTopicArnNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSTopicArnNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The SNS topic ARN does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The minimum capacity must be less than or equal to the maximum capacity.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The maximum capacity must be greater than or equal to the minimum capacity.

" + } + }, + "AutoPause": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

\n " + } + }, + "SecondsUntilAutoPause": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

\n

Specify a value between 300 and 86,400 seconds.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

\n \n

If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless v1 from finding a scaling point might be dropped.

\n \n

For more information, see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.

\n

Specify a value between 60 and 600 seconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

" + } + }, + "AutoPause": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

" + } + }, + "SecondsUntilAutoPause": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The remaining amount of time, in seconds, before the Aurora DB cluster in\n serverless mode is paused. A DB cluster can be paused only when\n it's idle (it has no connections).

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or\n RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds before scaling times out. What happens when an attempted scaling action times out\n is determined by the TimeoutAction setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SharedSnapshotQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n snapshots.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SourceClusterNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceClusterNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The source DB cluster isn't supported for a blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SourceDatabaseNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceDatabaseNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The source DB instance isn't supported for a blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SourceIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "SourceId" + } + } + }, + "com.amazonaws.rds#SourceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested source could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#SourceRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the source Amazon Web Services Region.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint for the source Amazon Web Services Region endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the source Amazon Web Services Region.

" + } + }, + "SupportsDBInstanceAutomatedBackupsReplication": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

" + } + }, + "com.amazonaws.rds#SourceRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#SourceRegion", + "traits": { + "smithy.api#xmlName": "SourceRegion" + } + } + }, + "com.amazonaws.rds#SourceRegionMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "SourceRegions": { + "target": "com.amazonaws.rds#SourceRegionList", + "traits": { + "smithy.api#documentation": "

A list of SourceRegion instances that contains each source Amazon Web Services Region that the\n current Amazon Web Services Region can get a read replica or a DB snapshot from.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeSourceRegions action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SourceType": { + "type": "enum", + "members": { + "db_instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-instance" + } + }, + "db_parameter_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-parameter-group" + } + }, + "db_security_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-security-group" + } + }, + "db_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-snapshot" + } + }, + "db_cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-cluster" + } + }, + "db_cluster_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-cluster-snapshot" + } + }, + "custom_engine_version": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom-engine-version" + } + }, + "db_proxy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-proxy" + } + }, + "blue_green_deployment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blue-green-deployment" + } + } + } + }, + "com.amazonaws.rds#StartActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#StartActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a database activity stream to monitor activity on the database.\n For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide or\n \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

", + "smithy.api#examples": [ + { + "title": "To start a database activity stream", + "documentation": "The following example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.", + "input": { + "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", + "Mode": "async", + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "ApplyImmediately": true }, - "traits": { - "smithy.api#documentation": "

Specifies the details of authentication used by a proxy to log in as a specific database user.

" + "output": { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "starting", + "Mode": "async", + "ApplyImmediately": true } - }, - "com.amazonaws.rds#UserAuthConfigInfo": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" - } - }, - "UserName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" - } - }, - "AuthScheme": { - "target": "com.amazonaws.rds#AuthScheme", - "traits": { - "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" - } - }, - "IAMAuth": { - "target": "com.amazonaws.rds#IAMAuthMode", - "traits": { - "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" - } - }, - "ClientPasswordAuthType": { - "target": "com.amazonaws.rds#ClientPasswordAuthType", - "traits": { - "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" - } - } + } + ] + } + }, + "com.amazonaws.rds#StartActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster,\n for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.\n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the database activity stream includes engine-native audit fields. This option applies\n to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StartActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StartDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To start a DB cluster", + "documentation": "The following example starts a DB cluster and its DB instances.", + "input": { + "DBClusterIdentifier": "mydbcluster" }, - "traits": { - "smithy.api#documentation": "

Returns the details of authentication used by a proxy to log in as a specific database user.

" - } + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": ["us-east-1a", "us-east-1e", "us-east-1b"], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydb", + "DBClusterIdentifier": "mydbcluster" + } + } + } + ] + } + }, + "com.amazonaws.rds#StartDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as\n a lowercase string.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StartDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StartDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" }, - "com.amazonaws.rds#UserAuthConfigInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#UserAuthConfigInfo" - } + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, - "com.amazonaws.rds#UserAuthConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#UserAuthConfig" - } + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" }, - "com.amazonaws.rds#ValidDBInstanceModificationsMessage": { - "type": "structure", - "members": { - "Storage": { - "target": "com.amazonaws.rds#ValidStorageOptionsList", - "traits": { - "smithy.api#documentation": "

Valid storage options for your DB instance.

" - } - }, - "ValidProcessorFeatures": { - "target": "com.amazonaws.rds#AvailableProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

Valid processor features for your DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n You can use this information when you call\n ModifyDBInstance.

" - } + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" }, - "com.amazonaws.rds#ValidStorageOptions": { - "type": "structure", - "members": { - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The valid storage types for your DB instance.\n For example: gp2, gp3, io1.

" - } - }, - "StorageSize": { - "target": "com.amazonaws.rds#RangeList", - "traits": { - "smithy.api#documentation": "

The valid range of storage in gibibytes (GiB).\n For example, 100 to 16,384.

" - } - }, - "ProvisionedIops": { - "target": "com.amazonaws.rds#RangeList", - "traits": { - "smithy.api#documentation": "

The valid range of provisioned IOPS.\n For example, 1000-256,000.

" - } - }, - "IopsToStorageRatio": { - "target": "com.amazonaws.rds#DoubleRangeList", - "traits": { - "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" - } - }, - "SupportsStorageAutoscaling": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" - } - }, - "ProvisionedStorageThroughput": { - "target": "com.amazonaws.rds#RangeList", - "traits": { - "smithy.api#documentation": "

The valid range of provisioned storage throughput. For example, \n 500-4,000 mebibytes per second (MiBps).

" - } - }, - "StorageThroughputToIopsRatio": { - "target": "com.amazonaws.rds#DoubleRangeList", - "traits": { - "smithy.api#documentation": "

The valid range of storage throughput to provisioned IOPS ratios. For example, \n 0-0.25.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.

" - } + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" }, - "com.amazonaws.rds#ValidStorageOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ValidStorageOptions", - "traits": { - "smithy.api#xmlName": "ValidStorageOptions" - } - } + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" }, - "com.amazonaws.rds#ValidUpgradeTargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#UpgradeTarget", - "traits": { - "smithy.api#xmlName": "UpgradeTarget" - } - } + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" }, - "com.amazonaws.rds#VpcSecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "VpcSecurityGroupId" - } - } + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" }, - "com.amazonaws.rds#VpcSecurityGroupMembership": { - "type": "structure", - "members": { - "VpcSecurityGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the VPC security group.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The membership status of the VPC security group.

\n

Currently, the only valid status is active.

" - } - } + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

\n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

\n ", + "smithy.api#examples": [ + { + "title": "To start a DB instance", + "documentation": "The following example starts the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element for queries on VPC security group membership.

" + "output": { + "DBInstance": { + "DBInstanceStatus": "starting" + } } + } + ] + } + }, + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Enables replication of automated backups to a different Amazon Web Services Region.

\n

This command doesn't apply to RDS Custom.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

", + "smithy.api#examples": [ + { + "title": "To enable cross-Region automated backups", + "documentation": "The following example replicates automated backups from a DB instance in the US East (N. Virginia) Region. The backup retention period is 14 days.", + "input": { + "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "BackupRetentionPeriod": 14 + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": {}, + "AllocatedStorage": 20, + "Status": "pending", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 14, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] + } + }, + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { + "type": "structure", + "members": { + "SourceDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", + "smithy.api#required": {} + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The retention period for the replicated automated backups.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\n Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, \n arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StartDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StartDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StartExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartExportTaskMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTask" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" }, - "com.amazonaws.rds#VpcSecurityGroupMembershipList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembership", - "traits": { - "smithy.api#xmlName": "VpcSecurityGroupMembership" - } - } + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" }, - "com.amazonaws.rds#WriteForwardingStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "ENABLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabling" - } - }, - "DISABLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabling" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } - } + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ExportTaskAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#IamRoleMissingPermissionsFault" + }, + { + "target": "com.amazonaws.rds#IamRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportOnlyFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportSourceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

\n

You can't export snapshot data from RDS Custom DB instances.

\n

You can't export cluster data from Multi-AZ DB clusters.

\n

For more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.

\n

For more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.

", + "smithy.api#examples": [ + { + "title": "To export a snapshot to Amazon S3", + "documentation": "The following example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.", + "input": { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "S3BucketName": "mybucket", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff" + }, + "output": { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "mybucket", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + } + ] + } + }, + "com.amazonaws.rds#StartExportTaskMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the export task. This ID isn't an identifier for\n the Amazon S3 bucket where the data is to be exported.

", + "smithy.api#required": {} + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket to export the snapshot or cluster data to.

", + "smithy.api#required": {} + } + }, + "IamRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot or cluster.

\n

In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon\n RDS or Amazon Aurora to an S3 bucket:

\n
    \n
  • \n

    s3:PutObject*

    \n
    • \n
  • \n

    s3:GetObject*

    \n
    • \n
  • \n

    s3:ListBucket

    \n
    • \n
  • \n

    s3:DeleteObject*

    \n
    • \n
  • \n

    s3:GetBucketLocation

    \n
    • \n
\n

In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows\n the Amazon Resource Name (ARN) format for accessing S3:

\n
    \n
  • \n

    \n arn:aws:s3:::your-s3-bucket\n \n

    \n
    • \n
  • \n

    \n arn:aws:s3:::your-s3-bucket/*\n

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to run the following operations. \n These can be set in the Amazon Web Services KMS key policy:

\n
    \n
  • \n

    kms:Encrypt

    \n
    • \n
  • \n

    kms:Decrypt

    \n
    • \n
  • \n

    kms:GenerateDataKey

    \n
    • \n
  • \n

    kms:GenerateDataKeyWithoutPlaintext

    \n
    • \n
  • \n

    kms:ReEncryptFrom

    \n
    • \n
  • \n

    kms:ReEncryptTo

    \n
    • \n
  • \n

    kms:CreateGrant

    \n
    • \n
  • \n

    kms:DescribeKey

    \n
    • \n
  • \n

    kms:RetireGrant

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix to use as the file name and path of the exported data.

" + } + }, + "ExportOnly": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The data to be exported from the snapshot or cluster. \n If this parameter is not provided, all of the data is exported.\n Valid values are the following:

\n
    \n
  • \n

    \n database - Export all the data from a specified database.

    \n
    • \n
  • \n

    \n database.table\n table-name - \n Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

    \n
    • \n
  • \n

    \n database.schema\n schema-name - Export a database schema of the snapshot or cluster. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
  • \n

    \n database.schema.table\n table-name - Export a table of the database schema. \n This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#StopActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

\n

For more information, see \n \n Monitoring Amazon Aurora with Database Activity Streams\n in the Amazon Aurora User Guide\n or \n Monitoring Amazon RDS with Database Activity Streams\n in the Amazon RDS User Guide.

", + "smithy.api#examples": [ + { + "title": "To stop a database activity stream", + "documentation": "The following example stops an activity stream in an Aurora cluster named my-pg-cluster.", + "input": { + "ResourceArn": "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster", + "ApplyImmediately": true + }, + "output": { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "stopping" + } + } + ] + } + }, + "com.amazonaws.rds#StopActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StopDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#examples": [ + { + "title": "To stop a DB cluster", + "documentation": "The following example stops a DB cluster and its DB instances.", + "input": { + "DBClusterIdentifier": "mydbcluster" + }, + "output": { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": ["us-east-1a", "us-east-1e", "us-east-1b"], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydb", + "DBClusterIdentifier": "mydbcluster" + } + } + } + ] + } + }, + "com.amazonaws.rds#StopDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as\n a lowercase string.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StopDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.

\n

For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.

\n ", + "smithy.api#examples": [ + { + "title": "To stop a DB instance", + "documentation": "The following example stops the specified DB instance.", + "input": { + "DBInstanceIdentifier": "test-instance" + }, + "output": { + "DBInstance": { + "DBInstanceStatus": "stopping" + } } + } + ] + } + }, + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

", + "smithy.api#examples": [ + { + "title": "To stop replicating automated backups", + "documentation": "The following example ends replication of automated backups. Replicated backups are retained according to the set backup retention period.", + "input": { + "SourceDBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" + }, + "output": { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": { + "EarliestTime": "2020-12-04T23:13:21.030Z", + "LatestTime": "2020-12-07T19:59:57Z" + }, + "AllocatedStorage": 20, + "Status": "replicating", + "Port": 1521, + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 7, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + } + ] + } + }, + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { + "type": "structure", + "members": { + "SourceDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating\n automate backups, for example,\n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StopDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier.

", + "smithy.api#required": {} + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#StopDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#StorageQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed amount of storage\n available across all DB instances.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#StorageTypeNotAvailableFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageTypeNotAvailableFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The aurora-iopt1 storage type isn't available, because you modified the DB cluster \n to use this storage type less than one month ago.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#StorageTypeNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified StorageType can't be associated with the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#String": { + "type": "string" + }, + "com.amazonaws.rds#String255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Subnet": { + "type": "structure", + "members": { + "SubnetIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet.

" + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.rds#AvailabilityZone" + }, + "SubnetOutpost": { + "target": "com.amazonaws.rds#Outpost", + "traits": { + "smithy.api#documentation": "

If the subnet is associated with an Outpost, this value specifies the Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "SubnetStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the subnet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element for the DescribeDBSubnetGroups operation.

" + } + }, + "com.amazonaws.rds#SubnetAlreadyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetAlreadyInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet is already in use in the Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SubnetIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "SubnetIdentifier" + } + } + }, + "com.amazonaws.rds#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Subnet", + "traits": { + "smithy.api#xmlName": "Subnet" + } + } + }, + "com.amazonaws.rds#SubscriptionAlreadyExistFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionAlreadyExist", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The supplied subscription name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#SubscriptionCategoryNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionCategoryNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The supplied category does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#SubscriptionNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The subscription name does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#SupportedCharacterSetsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#CharacterSet", + "traits": { + "smithy.api#xmlName": "CharacterSet" + } + } + }, + "com.amazonaws.rds#SupportedTimezonesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Timezone", + "traits": { + "smithy.api#xmlName": "Timezone" + } + } + }, + "com.amazonaws.rds#SwitchoverBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Switches over a blue/green deployment.

\n

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

\n

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

" + } + }, + "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "SwitchoverTimeout": { + "target": "com.amazonaws.rds#SwitchoverTimeout", + "traits": { + "smithy.api#documentation": "

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

\n

Default: 300

\n

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

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SwitchoverDetail": { + "type": "structure", + "members": { + "SourceMember": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the blue environment.

" + } + }, + "TargetMember": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the green environment.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#SwitchoverDetailStatus", + "traits": { + "smithy.api#documentation": "

The switchover status of a resource in a blue/green deployment.

\n

Values:

\n
    \n
  • \n

    \n PROVISIONING - The resource is being prepared to switch\n over.

    \n
    • \n
  • \n

    \n AVAILABLE - The resource is ready to switch over.

    \n
    • \n
  • \n

    \n SWITCHOVER_IN_PROGRESS - The resource is being switched\n over.

    \n
    • \n
  • \n

    \n SWITCHOVER_COMPLETED - The resource has been switched\n over.

    \n
    • \n
  • \n

    \n SWITCHOVER_FAILED - The resource attempted to switch over but\n failed.

    \n
    • \n
  • \n

    \n MISSING_SOURCE - The source resource has been deleted.

    \n
    • \n
  • \n

    \n MISSING_TARGET - The target resource has been deleted.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

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

" + } + }, + "com.amazonaws.rds#SwitchoverDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#SwitchoverDetail" + } + }, + "com.amazonaws.rds#SwitchoverDetailStatus": { + "type": "string" + }, + "com.amazonaws.rds#SwitchoverGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#SwitchoverGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#SwitchoverGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. \n Switchover operations were previously called \"managed planned failovers.\"

\n

Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster \n to a secondary (read-only) cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary \n at the beginning of the process so the new primary continues operations for the Aurora global database without losing any data. Your database \n is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. For more information about \n switching over an Aurora global database, see Performing switchovers for Amazon Aurora global databases in the Amazon Aurora User Guide.

\n \n

This operation is intended for controlled environments, for operations such as \"regional rotation\" or to fall back to the original \n primary after a global database failover.

\n " + } + }, + "com.amazonaws.rds#SwitchoverGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing global database cluster (Aurora global database).

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "TargetDbClusterIdentifier": { + "target": "com.amazonaws.rds#DBClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the secondary Aurora DB cluster to promote to the new primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#SwitchoverGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SwitchoverReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#SwitchoverReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#SwitchoverReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new\n primary database. Issue this command in the Region that hosts the current standby database.

" + } + }, + "com.amazonaws.rds#SwitchoverReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must match the identifier of an existing Oracle read replica DB instance.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rds#SwitchoverReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#SwitchoverTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30 + } + } + }, + "com.amazonaws.rds#TStamp": { + "type": "timestamp" + }, + "com.amazonaws.rds#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n

" + } + }, + "com.amazonaws.rds#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + }, + "traits": { + "smithy.api#documentation": "

A list of tags.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" + } + }, + "com.amazonaws.rds#TagListMessage": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#output": {} + } + }, + "com.amazonaws.rds#TargetDBClusterParameterGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" + } + }, + "com.amazonaws.rds#TargetDBParameterGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" + } + }, + "com.amazonaws.rds#TargetEngineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z-_.]+$" + } + }, + "com.amazonaws.rds#TargetGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyTargetGroup" + } + }, + "com.amazonaws.rds#TargetHealth": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.rds#TargetState", + "traits": { + "smithy.api#documentation": "

The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:

\n

\n registering > unavailable > available > unavailable > available\n

" + } + }, + "Reason": { + "target": "com.amazonaws.rds#TargetHealthReason", + "traits": { + "smithy.api#documentation": "

The reason for the current health State of the RDS Proxy target.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description of the health of the RDS Proxy target. \n If the State is AVAILABLE, a description is not included.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the connection health of an RDS Proxy target.

" + } + }, + "com.amazonaws.rds#TargetHealthReason": { + "type": "enum", + "members": { + "UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNREACHABLE" + } + }, + "CONNECTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTION_FAILED" + } + }, + "AUTH_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTH_FAILURE" + } + }, + "PENDING_PROXY_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_PROXY_CAPACITY" + } + }, + "INVALID_REPLICATION_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_REPLICATION_STATE" + } + } + } + }, + "com.amazonaws.rds#TargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyTarget" + } + }, + "com.amazonaws.rds#TargetRole": { + "type": "enum", + "members": { + "READ_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_WRITE" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } + }, + "com.amazonaws.rds#TargetState": { + "type": "enum", + "members": { + "registering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + } + } + }, + "com.amazonaws.rds#TargetType": { + "type": "enum", + "members": { + "RDS_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_INSTANCE" + } + }, + "RDS_SERVERLESS_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_SERVERLESS_ENDPOINT" + } + }, + "TRACKED_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRACKED_CLUSTER" + } + } + } + }, + "com.amazonaws.rds#Timezone": { + "type": "structure", + "members": { + "TimezoneName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the time zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A time zone associated with a \n DBInstance \n or a DBSnapshot.\n This data type is an element in the response to \n the DescribeDBInstances, \n the DescribeDBSnapshots,\n and the DescribeDBEngineVersions\n actions.

" + } + }, + "com.amazonaws.rds#UpgradeTarget": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the upgrade target database engine.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the upgrade target database engine.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" + } + }, + "AutoUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" + } + }, + "IsMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes for the target engine version.

" + } + }, + "SupportsParallelQuery": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with the target engine version.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with the target engine version.

" + } + }, + "SupportsBabelfish": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

" + } + }, + "SupportsLocalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the target engine version supports forwarding write operations from reader DB instances \n to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

\n

Valid for: Aurora DB clusters only

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" + } + }, + "com.amazonaws.rds#UserAuthConfig": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" + } + }, + "UserName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" + } + }, + "AuthScheme": { + "target": "com.amazonaws.rds#AuthScheme", + "traits": { + "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" + } + }, + "IAMAuth": { + "target": "com.amazonaws.rds#IAMAuthMode", + "traits": { + "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" + } + }, + "ClientPasswordAuthType": { + "target": "com.amazonaws.rds#ClientPasswordAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the details of authentication used by a proxy to log in as a specific database user.

" + } + }, + "com.amazonaws.rds#UserAuthConfigInfo": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" + } + }, + "UserName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" + } + }, + "AuthScheme": { + "target": "com.amazonaws.rds#AuthScheme", + "traits": { + "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" + } + }, + "IAMAuth": { + "target": "com.amazonaws.rds#IAMAuthMode", + "traits": { + "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" + } + }, + "ClientPasswordAuthType": { + "target": "com.amazonaws.rds#ClientPasswordAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the details of authentication used by a proxy to log in as a specific database user.

" + } + }, + "com.amazonaws.rds#UserAuthConfigInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UserAuthConfigInfo" + } + }, + "com.amazonaws.rds#UserAuthConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UserAuthConfig" + } + }, + "com.amazonaws.rds#ValidDBInstanceModificationsMessage": { + "type": "structure", + "members": { + "Storage": { + "target": "com.amazonaws.rds#ValidStorageOptionsList", + "traits": { + "smithy.api#documentation": "

Valid storage options for your DB instance.

" + } + }, + "ValidProcessorFeatures": { + "target": "com.amazonaws.rds#AvailableProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

Valid processor features for your DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n You can use this information when you call\n ModifyDBInstance.

" + } + }, + "com.amazonaws.rds#ValidStorageOptions": { + "type": "structure", + "members": { + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The valid storage types for your DB instance.\n For example: gp2, gp3, io1.

" + } + }, + "StorageSize": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of storage in gibibytes (GiB).\n For example, 100 to 16,384.

" + } + }, + "ProvisionedIops": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of provisioned IOPS.\n For example, 1000-256,000.

" + } + }, + "IopsToStorageRatio": { + "target": "com.amazonaws.rds#DoubleRangeList", + "traits": { + "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" + } + }, + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" + } + }, + "ProvisionedStorageThroughput": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of provisioned storage throughput. For example, \n 500-4,000 mebibytes per second (MiBps).

" + } + }, + "StorageThroughputToIopsRatio": { + "target": "com.amazonaws.rds#DoubleRangeList", + "traits": { + "smithy.api#documentation": "

The valid range of storage throughput to provisioned IOPS ratios. For example, \n 0-0.25.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.

" + } + }, + "com.amazonaws.rds#ValidStorageOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ValidStorageOptions", + "traits": { + "smithy.api#xmlName": "ValidStorageOptions" + } + } + }, + "com.amazonaws.rds#ValidUpgradeTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UpgradeTarget", + "traits": { + "smithy.api#xmlName": "UpgradeTarget" + } + } + }, + "com.amazonaws.rds#VpcSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "VpcSecurityGroupId" + } + } + }, + "com.amazonaws.rds#VpcSecurityGroupMembership": { + "type": "structure", + "members": { + "VpcSecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the VPC security group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The membership status of the VPC security group.

\n

Currently, the only valid status is active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element for queries on VPC security group membership.

" + } + }, + "com.amazonaws.rds#VpcSecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembership", + "traits": { + "smithy.api#xmlName": "VpcSecurityGroupMembership" + } + } + }, + "com.amazonaws.rds#WriteForwardingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } } + } } + } }