The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

Undocumented member.

The response's http status code.

This parameter is not currently supported.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

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

Constraints:

• If provided, must match the name of an existing DBClusterParameterGroup.

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.

A list of cluster parameter groups.

The response's http status code.

The database engine version to return.

Example: 3.6.0

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

Indicates that only the default version of the specified engine or engine and major version combination is returned.

This parameter is not currently supported.

The database engine to return.

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

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

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

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

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.

Detailed information about one or more engine versions.

The response's http status code.

The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.

The identifier of the event source to be added:

• If the source type is an instance, a DBInstanceIdentifier must be provided.
• If the source type is a security group, a DBSecurityGroupName must be provided.
• If the source type is a parameter group, a DBParameterGroupName must be provided.
• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

Undocumented member.

The response's http status code.

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Regions.

If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

Indicates the certificate that needs to be associated with the instance.

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.

If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

The instance identifier. This value is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing DBInstance.

Undocumented member.

The response's http status code.

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.

A Boolean value; set to true to activate the subscription.

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-parameter-group, db-security-group

A list of event categories for a SourceType that you want to subscribe to.

The name of the Amazon DocumentDB event notification subscription.

Undocumented member.

The response's http status code.

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

The name of the cluster parameter group to reset.

The name of a cluster parameter group.

Constraints:

• Must be from 1 to 255 letters or numbers.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

The event source to retrieve events for. If no value is specified, all events are returned.

This parameter is not currently supported.

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

• If SourceIdentifier is provided, SourceType must also be provided.
• If the source type is DBInstance, a DBInstanceIdentifier must be provided.
• If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.
• If the source type is DBParameterGroup, a DBParameterGroupName must be provided.
• If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.
• Cannot end with a hyphen or contain two consecutive hyphens.

A list of event categories that trigger notifications for an event notification subscription.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

The number of minutes to retrieve events for.

Default: 60

Detailed information about one or more events.

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.

The response's http status code.

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

• If provided, must match an existing DBClusterIdentifier.

A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

A list of clusters.

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.

The response's http status code.

The description for the subnet group.

The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

The Amazon EC2 subnet IDs for the subnet group.

Undocumented member.

The response's http status code.

This parameter is not currently supported.

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

A list of one or more tags.

The response's http status code.

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

• Must be from 1 to 255 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

• Must match an existing DBClusterIdentifier.

Undocumented member.

The response's http status code.

The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.

The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.

Undocumented member.

The response's http status code.

This parameter is not currently supported.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

The name of the cluster parameter group family to return the engine parameter information for.

Undocumented member.

The response's http status code.

The cluster identifier of the global cluster being deleted.

Undocumented member.

The response's http status code.

The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

The tag key (name) of the tag to be removed.

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

A list of event categories for a SourceType that you want to subscribe to.

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. 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.

Constraints:

• If SourceIds are provided, SourceType must also be provided.
• If the source type is an instance, a DBInstanceIdentifier must be provided.
• If the source type is a security group, a DBSecurityGroupName must be provided.
• If the source type is a parameter group, a DBParameterGroupName must be provided.
• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

The tags to be assigned to the event subscription.

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

Undocumented member.

The response's http status code.

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Region.

Example: us-east-1d

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

The compute and memory capacity of the instance; for example, db.r5.large.

The name of the database engine to be used for this instance.

Valid value: docdb

The identifier of the cluster that the instance will belong to.

Undocumented member.

The response's http status code.

The name of the cluster parameter group.

Constraints:

• Must be the name of an existing cluster parameter group.
• You can't delete a default cluster parameter group.
• Cannot be associated with any clusters.

This parameter is not currently supported.

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

• Must match an existing CertificateIdentifier.

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

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 that the remaining results can be retrieved.

Default: 100

Constraints:

• Minimum: 20
• Maximum: 100

A list of certificates for this account.

An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

The response's http status code.

The version of the database engine to use for the new cluster.

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

• If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
• If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

The tags to be assigned to the restored cluster.

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

• Must match the identifier of an existing snapshot.

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Undocumented member.

The response's http status code.

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

This parameter is not currently supported.

The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

The name of the engine to retrieve instance options for.

The options that are available for a particular orderable instance.

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.

The response's http status code.

The tags to be assigned to the cluster parameter group.

The name of the cluster parameter group.

Constraints:

• Must not match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

The cluster parameter group family name.

The description for the cluster parameter group.

Undocumented member.

The response's http status code.

The name of the Amazon DocumentDB event notification subscription that you want to delete.

Undocumented member.

The response's http status code.

The cluster identifier to detach from the Amazon DocumentDB global cluster.

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.

Undocumented member.

The response's http status code.

The identifier of the cluster snapshot to delete.

Constraints: Must be the name of an existing cluster snapshot in the available state.

Undocumented member.

The response's http status code.

The name of the Amazon DocumentDB event notification subscription that you want to describe.

This parameter is not currently supported.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

A list of event subscriptions.

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.

The response's http status code.

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

The tags to be assigned to the Amazon DocumentDB resource.

The tags to be assigned to the cluster snapshot.

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Example: my-cluster

Undocumented member.

The response's http status code.

The name of the subnet group to return details for.

This parameter is not currently supported.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Detailed information about one or more subnet groups.

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.

The response's http status code.

The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

Undocumented member.

The response's http status code.

A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all accounts.

A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to all . If you specify all, an account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

The identifier for the cluster snapshot to modify the attributes for.

The name of the cluster snapshot attribute to modify.

To manage authorization for other accounts to copy or restore a manual cluster snapshot, set this value to restore.

Undocumented member.

The response's http status code.

The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB.

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.
• Must be in Universal Coordinated Time (UTC).
• Must not conflict with the preferred maintenance window.
• Must be at least 30 minutes.

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35.

A list of virtual private cloud (VPC) security groups that the cluster will belong to.

The name of the cluster parameter group to use for the cluster.

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

The port number on which the cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Undocumented member.

The response's http status code.

The tags that are to be assigned to the parameter group.

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

• Must specify a valid cluster parameter group.
• If the source cluster parameter group is in the same Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.
• If the source parameter group is in a different Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

The identifier for the copied cluster parameter group.

Constraints:

• Cannot be null, empty, or blank.
• Must contain from 1 to 255 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

A description for the copied cluster parameter group.

Undocumented member.

The response's http status code.

The type of source that is generating the events.

Valid values: db-instance, db-parameter-group, db-security-group

This parameter is not currently supported.

A list of event category maps.

The response's http status code.

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

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

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 that you can retrieve the remaining results.

The response's http status code.

The name of the cluster parameter group to modify.

A list of parameters in the cluster parameter group to modify.

The name of a cluster parameter group.

Constraints:

• Must be from 1 to 255 letters or numbers.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

The identifier for the cluster snapshot to describe the attributes for.

Undocumented member.

The response's http status code.

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.
• db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

The ARN of a resource to return pending maintenance actions for.

The maintenance actions to be applied.

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.

The response's http status code.

The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot API action in the Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Region.

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

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

• SourceRegion - The ID of the region that contains the snapshot to be copied.
• SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
• TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.

The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

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

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

To copy an encrypted cluster snapshot to another Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. KMS encryption keys are specific to the Region that they are created in, and you can't use encryption keys from one Region in another Region.

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

The tags to be assigned to the cluster snapshot.

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

• Must specify a valid system snapshot in the available state.
• If the source snapshot is in the same Region as the copy, specify a valid snapshot identifier.
• If the source snapshot is in a different Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Undocumented member.

The response's http status code.

The engine version of the global cluster.

The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled.

The storage encryption setting for the new global cluster.

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

The name of the database engine to be used for this cluster.

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.

The cluster identifier of the new global cluster.

Undocumented member.

The response's http status code.

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Specifies whether the cluster is encrypted.

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

The cluster identifier of the new global cluster.

The name of the master user for the cluster.

Constraints:

• Must be from 1 to 63 letters or numbers.
• The first character must be a letter.
• Cannot be a reserved word for the chosen database engine.

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Not currently supported.

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

The KMS key identifier for an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

• If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

KMS creates the default encryption key for your account. Your account has a different default encryption key for each Regions.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Region.

Constraints:

• Must be in the format hh24:mi-hh24:mi.
• Must be in Universal Coordinated Time (UTC).
• Must not conflict with the preferred maintenance window.
• Must be at least 30 minutes.

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35.

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

The name of the cluster parameter group to associate with this cluster.

The tags to be assigned to the cluster.

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

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

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

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

The name of the database engine to be used for this cluster.

Valid values: docdb

Undocumented member.

The response's http status code.

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Undocumented member.

The response's http status code.

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

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

Valid values:

• immediate - Apply the maintenance action immediately.
• next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
• undo-opt-in - Cancel any existing next-maintenance opt-in requests.

Undocumented member.

The response's http status code.

This parameter is not currently supported.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

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

Constraints:

• If provided, must match the name of an existing DBClusterParameterGroup.

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.

Provides a list of parameters for the cluster parameter group.

The response's http status code.

The name of the database subnet group to delete.

You can't delete the default subnet group.

Constraints:

Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

• If provided, must match the identifier of an existing DBCluster.

Set to true to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise false. The default is false.

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

• If provided, must match the identifier of an existing DBClusterSnapshot.
• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

This parameter is not currently supported.

The type of cluster snapshots to be returned. You can specify one of the following values:

• automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your account.
• manual - Return all cluster snapshots that you have manually created for your account.
• shared - Return all manual cluster snapshots that have been shared to your account.
• public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to 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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Set to true to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise false. The default is false.

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.

Provides a list of cluster snapshots.

The response's http status code.

When true, the reboot is conducted through a Multi-AZ failover.

Constraint: You can't specify true if the instance is not configured for Multi-AZ.

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing DBInstance.

Undocumented member.

The response's http status code.

The tags to be assigned to the subnet group.

The name for the subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

The description for the subnet group.

The Amazon EC2 subnet IDs for the subnet group.

Undocumented member.

The response's http status code.

The instance identifier for the instance to be deleted. This parameter isn't case sensitive.

Constraints:

• Must match the name of an existing instance.

Undocumented member.

The response's http status code.

Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

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

  The first character must be a letter

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

Example: my-cluster2

The identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

• Must match the identifier of an existing global cluster.

Undocumented member.

The response's http status code.

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

• If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
• If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

A list of VPC security groups that the new cluster belongs to.

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

• Must be before the latest restorable time for the instance.
• Must be specified if the UseLatestRestorableTime parameter is not provided.
• Cannot be specified if the UseLatestRestorableTime parameter is true.
• Cannot be specified if the RestoreType parameter is copy-on-write.

Example: 2015-03-07T23:45:00Z

The tags to be assigned to the restored cluster.

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

The name of the new cluster to be created.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

The identifier of the source cluster from which to restore.

Constraints:

• Must match the identifier of an existing DBCluster.

Undocumented member.

The response's http status code.

A filter that specifies one or more instances to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
• db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

Constraints:

• If provided, must match the identifier of an existing DBInstance.

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.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Detailed information about one or more instances.

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.

The response's http status code.

The name of the Availability Zone.

The type of the certificate.

Example: CA

The Amazon Resource Name (ARN) for the certificate.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

The unique key that identifies a certificate.

Example: rds-ca-2019

The thumbprint of the certificate.

The starting date-time from which the certificate is valid.

Example: 2019-07-31T17:57:09Z

The list of log types to disable.

The list of log types to enable.

Indicates the database engine version.