docdb.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {WaiterConfiguration} from '../lib/service'; 6 import {ServiceConfigurationOptions} from '../lib/service'; 7 import {ConfigBase as Config} from '../lib/config-base'; 8 interface Blob {} 9 declare class DocDB extends Service { 10 /** 11 * Constructs a service object. This object has one method for each API operation. 12 */ 13 constructor(options?: DocDB.Types.ClientConfiguration) 14 config: Config & DocDB.Types.ClientConfiguration; 15 /** 16 * Adds a source identifier to an existing event notification subscription. 17 */ 18 addSourceIdentifierToSubscription(params: DocDB.Types.AddSourceIdentifierToSubscriptionMessage, callback?: (err: AWSError, data: DocDB.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<DocDB.Types.AddSourceIdentifierToSubscriptionResult, AWSError>; 19 /** 20 * Adds a source identifier to an existing event notification subscription. 21 */ 22 addSourceIdentifierToSubscription(callback?: (err: AWSError, data: DocDB.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<DocDB.Types.AddSourceIdentifierToSubscriptionResult, AWSError>; 23 /** 24 * Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB. 25 */ 26 addTagsToResource(params: DocDB.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 27 /** 28 * Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB. 29 */ 30 addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 31 /** 32 * Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance). 33 */ 34 applyPendingMaintenanceAction(params: DocDB.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: DocDB.Types.ApplyPendingMaintenanceActionResult) => void): Request<DocDB.Types.ApplyPendingMaintenanceActionResult, AWSError>; 35 /** 36 * Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance). 37 */ 38 applyPendingMaintenanceAction(callback?: (err: AWSError, data: DocDB.Types.ApplyPendingMaintenanceActionResult) => void): Request<DocDB.Types.ApplyPendingMaintenanceActionResult, AWSError>; 39 /** 40 * Copies the specified cluster parameter group. 41 */ 42 copyDBClusterParameterGroup(params: DocDB.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterParameterGroupResult) => void): Request<DocDB.Types.CopyDBClusterParameterGroupResult, AWSError>; 43 /** 44 * Copies the specified cluster parameter group. 45 */ 46 copyDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterParameterGroupResult) => void): Request<DocDB.Types.CopyDBClusterParameterGroupResult, AWSError>; 47 /** 48 * Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Region. To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status. 49 */ 50 copyDBClusterSnapshot(params: DocDB.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterSnapshotResult) => void): Request<DocDB.Types.CopyDBClusterSnapshotResult, AWSError>; 51 /** 52 * Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Region. To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status. 53 */ 54 copyDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterSnapshotResult) => void): Request<DocDB.Types.CopyDBClusterSnapshotResult, AWSError>; 55 /** 56 * Creates a new Amazon DocumentDB cluster. 57 */ 58 createDBCluster(params: DocDB.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterResult) => void): Request<DocDB.Types.CreateDBClusterResult, AWSError>; 59 /** 60 * Creates a new Amazon DocumentDB cluster. 61 */ 62 createDBCluster(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterResult) => void): Request<DocDB.Types.CreateDBClusterResult, AWSError>; 63 /** 64 * Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups. 65 */ 66 createDBClusterParameterGroup(params: DocDB.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterParameterGroupResult) => void): Request<DocDB.Types.CreateDBClusterParameterGroupResult, AWSError>; 67 /** 68 * Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups. 69 */ 70 createDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterParameterGroupResult) => void): Request<DocDB.Types.CreateDBClusterParameterGroupResult, AWSError>; 71 /** 72 * Creates a snapshot of a cluster. 73 */ 74 createDBClusterSnapshot(params: DocDB.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterSnapshotResult) => void): Request<DocDB.Types.CreateDBClusterSnapshotResult, AWSError>; 75 /** 76 * Creates a snapshot of a cluster. 77 */ 78 createDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterSnapshotResult) => void): Request<DocDB.Types.CreateDBClusterSnapshotResult, AWSError>; 79 /** 80 * Creates a new instance. 81 */ 82 createDBInstance(params: DocDB.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBInstanceResult) => void): Request<DocDB.Types.CreateDBInstanceResult, AWSError>; 83 /** 84 * Creates a new instance. 85 */ 86 createDBInstance(callback?: (err: AWSError, data: DocDB.Types.CreateDBInstanceResult) => void): Request<DocDB.Types.CreateDBInstanceResult, AWSError>; 87 /** 88 * Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region. 89 */ 90 createDBSubnetGroup(params: DocDB.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBSubnetGroupResult) => void): Request<DocDB.Types.CreateDBSubnetGroupResult, AWSError>; 91 /** 92 * Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region. 93 */ 94 createDBSubnetGroup(callback?: (err: AWSError, data: DocDB.Types.CreateDBSubnetGroupResult) => void): Request<DocDB.Types.CreateDBSubnetGroupResult, AWSError>; 95 /** 96 * Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console. You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account. 97 */ 98 createEventSubscription(params: DocDB.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: DocDB.Types.CreateEventSubscriptionResult) => void): Request<DocDB.Types.CreateEventSubscriptionResult, AWSError>; 99 /** 100 * Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console. You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account. 101 */ 102 createEventSubscription(callback?: (err: AWSError, data: DocDB.Types.CreateEventSubscriptionResult) => void): Request<DocDB.Types.CreateEventSubscriptionResult, AWSError>; 103 /** 104 * Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance. You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster. This action only applies to Amazon DocumentDB clusters. 105 */ 106 createGlobalCluster(params: DocDB.Types.CreateGlobalClusterMessage, callback?: (err: AWSError, data: DocDB.Types.CreateGlobalClusterResult) => void): Request<DocDB.Types.CreateGlobalClusterResult, AWSError>; 107 /** 108 * Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance. You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster. This action only applies to Amazon DocumentDB clusters. 109 */ 110 createGlobalCluster(callback?: (err: AWSError, data: DocDB.Types.CreateGlobalClusterResult) => void): Request<DocDB.Types.CreateGlobalClusterResult, AWSError>; 111 /** 112 * Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted. 113 */ 114 deleteDBCluster(params: DocDB.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterResult) => void): Request<DocDB.Types.DeleteDBClusterResult, AWSError>; 115 /** 116 * Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted. 117 */ 118 deleteDBCluster(callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterResult) => void): Request<DocDB.Types.DeleteDBClusterResult, AWSError>; 119 /** 120 * Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters. 121 */ 122 deleteDBClusterParameterGroup(params: DocDB.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 123 /** 124 * Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters. 125 */ 126 deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 127 /** 128 * Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The cluster snapshot must be in the available state to be deleted. 129 */ 130 deleteDBClusterSnapshot(params: DocDB.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterSnapshotResult) => void): Request<DocDB.Types.DeleteDBClusterSnapshotResult, AWSError>; 131 /** 132 * Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The cluster snapshot must be in the available state to be deleted. 133 */ 134 deleteDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterSnapshotResult) => void): Request<DocDB.Types.DeleteDBClusterSnapshotResult, AWSError>; 135 /** 136 * Deletes a previously provisioned instance. 137 */ 138 deleteDBInstance(params: DocDB.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBInstanceResult) => void): Request<DocDB.Types.DeleteDBInstanceResult, AWSError>; 139 /** 140 * Deletes a previously provisioned instance. 141 */ 142 deleteDBInstance(callback?: (err: AWSError, data: DocDB.Types.DeleteDBInstanceResult) => void): Request<DocDB.Types.DeleteDBInstanceResult, AWSError>; 143 /** 144 * Deletes a subnet group. The specified database subnet group must not be associated with any DB instances. 145 */ 146 deleteDBSubnetGroup(params: DocDB.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 147 /** 148 * Deletes a subnet group. The specified database subnet group must not be associated with any DB instances. 149 */ 150 deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 151 /** 152 * Deletes an Amazon DocumentDB event notification subscription. 153 */ 154 deleteEventSubscription(params: DocDB.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteEventSubscriptionResult) => void): Request<DocDB.Types.DeleteEventSubscriptionResult, AWSError>; 155 /** 156 * Deletes an Amazon DocumentDB event notification subscription. 157 */ 158 deleteEventSubscription(callback?: (err: AWSError, data: DocDB.Types.DeleteEventSubscriptionResult) => void): Request<DocDB.Types.DeleteEventSubscriptionResult, AWSError>; 159 /** 160 * Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster. This action only applies to Amazon DocumentDB clusters. 161 */ 162 deleteGlobalCluster(params: DocDB.Types.DeleteGlobalClusterMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteGlobalClusterResult) => void): Request<DocDB.Types.DeleteGlobalClusterResult, AWSError>; 163 /** 164 * Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster. This action only applies to Amazon DocumentDB clusters. 165 */ 166 deleteGlobalCluster(callback?: (err: AWSError, data: DocDB.Types.DeleteGlobalClusterResult) => void): Request<DocDB.Types.DeleteGlobalClusterResult, AWSError>; 167 /** 168 * Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account. 169 */ 170 describeCertificates(params: DocDB.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: DocDB.Types.CertificateMessage) => void): Request<DocDB.Types.CertificateMessage, AWSError>; 171 /** 172 * Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account. 173 */ 174 describeCertificates(callback?: (err: AWSError, data: DocDB.Types.CertificateMessage) => void): Request<DocDB.Types.CertificateMessage, AWSError>; 175 /** 176 * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group. 177 */ 178 describeDBClusterParameterGroups(params: DocDB.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupsMessage) => void): Request<DocDB.Types.DBClusterParameterGroupsMessage, AWSError>; 179 /** 180 * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group. 181 */ 182 describeDBClusterParameterGroups(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupsMessage) => void): Request<DocDB.Types.DBClusterParameterGroupsMessage, AWSError>; 183 /** 184 * Returns the detailed parameter list for a particular cluster parameter group. 185 */ 186 describeDBClusterParameters(params: DocDB.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupDetails) => void): Request<DocDB.Types.DBClusterParameterGroupDetails, AWSError>; 187 /** 188 * Returns the detailed parameter list for a particular cluster parameter group. 189 */ 190 describeDBClusterParameters(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupDetails) => void): Request<DocDB.Types.DBClusterParameterGroupDetails, AWSError>; 191 /** 192 * Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all accounts. 193 */ 194 describeDBClusterSnapshotAttributes(params: DocDB.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: DocDB.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<DocDB.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>; 195 /** 196 * Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all accounts. 197 */ 198 describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: DocDB.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<DocDB.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>; 199 /** 200 * Returns information about cluster snapshots. This API operation supports pagination. 201 */ 202 describeDBClusterSnapshots(params: DocDB.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterSnapshotMessage) => void): Request<DocDB.Types.DBClusterSnapshotMessage, AWSError>; 203 /** 204 * Returns information about cluster snapshots. This API operation supports pagination. 205 */ 206 describeDBClusterSnapshots(callback?: (err: AWSError, data: DocDB.Types.DBClusterSnapshotMessage) => void): Request<DocDB.Types.DBClusterSnapshotMessage, AWSError>; 207 /** 208 * Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters. 209 */ 210 describeDBClusters(params: DocDB.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterMessage) => void): Request<DocDB.Types.DBClusterMessage, AWSError>; 211 /** 212 * Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters. 213 */ 214 describeDBClusters(callback?: (err: AWSError, data: DocDB.Types.DBClusterMessage) => void): Request<DocDB.Types.DBClusterMessage, AWSError>; 215 /** 216 * Returns a list of the available engines. 217 */ 218 describeDBEngineVersions(params: DocDB.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: DocDB.Types.DBEngineVersionMessage) => void): Request<DocDB.Types.DBEngineVersionMessage, AWSError>; 219 /** 220 * Returns a list of the available engines. 221 */ 222 describeDBEngineVersions(callback?: (err: AWSError, data: DocDB.Types.DBEngineVersionMessage) => void): Request<DocDB.Types.DBEngineVersionMessage, AWSError>; 223 /** 224 * Returns information about provisioned Amazon DocumentDB instances. This API supports pagination. 225 */ 226 describeDBInstances(params: DocDB.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>; 227 /** 228 * Returns information about provisioned Amazon DocumentDB instances. This API supports pagination. 229 */ 230 describeDBInstances(callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>; 231 /** 232 * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. 233 */ 234 describeDBSubnetGroups(params: DocDB.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: DocDB.Types.DBSubnetGroupMessage) => void): Request<DocDB.Types.DBSubnetGroupMessage, AWSError>; 235 /** 236 * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. 237 */ 238 describeDBSubnetGroups(callback?: (err: AWSError, data: DocDB.Types.DBSubnetGroupMessage) => void): Request<DocDB.Types.DBSubnetGroupMessage, AWSError>; 239 /** 240 * Returns the default engine and system parameter information for the cluster database engine. 241 */ 242 describeEngineDefaultClusterParameters(params: DocDB.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: DocDB.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<DocDB.Types.DescribeEngineDefaultClusterParametersResult, AWSError>; 243 /** 244 * Returns the default engine and system parameter information for the cluster database engine. 245 */ 246 describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: DocDB.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<DocDB.Types.DescribeEngineDefaultClusterParametersResult, AWSError>; 247 /** 248 * Displays a list of categories for all event source types, or, if specified, for a specified source type. 249 */ 250 describeEventCategories(params: DocDB.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: DocDB.Types.EventCategoriesMessage) => void): Request<DocDB.Types.EventCategoriesMessage, AWSError>; 251 /** 252 * Displays a list of categories for all event source types, or, if specified, for a specified source type. 253 */ 254 describeEventCategories(callback?: (err: AWSError, data: DocDB.Types.EventCategoriesMessage) => void): Request<DocDB.Types.EventCategoriesMessage, AWSError>; 255 /** 256 * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. 257 */ 258 describeEventSubscriptions(params: DocDB.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: DocDB.Types.EventSubscriptionsMessage) => void): Request<DocDB.Types.EventSubscriptionsMessage, AWSError>; 259 /** 260 * Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. 261 */ 262 describeEventSubscriptions(callback?: (err: AWSError, data: DocDB.Types.EventSubscriptionsMessage) => void): Request<DocDB.Types.EventSubscriptionsMessage, AWSError>; 263 /** 264 * Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned. 265 */ 266 describeEvents(params: DocDB.Types.DescribeEventsMessage, callback?: (err: AWSError, data: DocDB.Types.EventsMessage) => void): Request<DocDB.Types.EventsMessage, AWSError>; 267 /** 268 * Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned. 269 */ 270 describeEvents(callback?: (err: AWSError, data: DocDB.Types.EventsMessage) => void): Request<DocDB.Types.EventsMessage, AWSError>; 271 /** 272 * Returns information about Amazon DocumentDB global clusters. This API supports pagination. This action only applies to Amazon DocumentDB clusters. 273 */ 274 describeGlobalClusters(params: DocDB.Types.DescribeGlobalClustersMessage, callback?: (err: AWSError, data: DocDB.Types.GlobalClustersMessage) => void): Request<DocDB.Types.GlobalClustersMessage, AWSError>; 275 /** 276 * Returns information about Amazon DocumentDB global clusters. This API supports pagination. This action only applies to Amazon DocumentDB clusters. 277 */ 278 describeGlobalClusters(callback?: (err: AWSError, data: DocDB.Types.GlobalClustersMessage) => void): Request<DocDB.Types.GlobalClustersMessage, AWSError>; 279 /** 280 * Returns a list of orderable instance options for the specified engine. 281 */ 282 describeOrderableDBInstanceOptions(params: DocDB.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: DocDB.Types.OrderableDBInstanceOptionsMessage) => void): Request<DocDB.Types.OrderableDBInstanceOptionsMessage, AWSError>; 283 /** 284 * Returns a list of orderable instance options for the specified engine. 285 */ 286 describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: DocDB.Types.OrderableDBInstanceOptionsMessage) => void): Request<DocDB.Types.OrderableDBInstanceOptionsMessage, AWSError>; 287 /** 288 * Returns a list of resources (for example, instances) that have at least one pending maintenance action. 289 */ 290 describePendingMaintenanceActions(params: DocDB.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: DocDB.Types.PendingMaintenanceActionsMessage) => void): Request<DocDB.Types.PendingMaintenanceActionsMessage, AWSError>; 291 /** 292 * Returns a list of resources (for example, instances) that have at least one pending maintenance action. 293 */ 294 describePendingMaintenanceActions(callback?: (err: AWSError, data: DocDB.Types.PendingMaintenanceActionsMessage) => void): Request<DocDB.Types.PendingMaintenanceActionsMessage, AWSError>; 295 /** 296 * Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing. 297 */ 298 failoverDBCluster(params: DocDB.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.FailoverDBClusterResult) => void): Request<DocDB.Types.FailoverDBClusterResult, AWSError>; 299 /** 300 * Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing. 301 */ 302 failoverDBCluster(callback?: (err: AWSError, data: DocDB.Types.FailoverDBClusterResult) => void): Request<DocDB.Types.FailoverDBClusterResult, AWSError>; 303 /** 304 * Lists all tags on an Amazon DocumentDB resource. 305 */ 306 listTagsForResource(params: DocDB.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: DocDB.Types.TagListMessage) => void): Request<DocDB.Types.TagListMessage, AWSError>; 307 /** 308 * Lists all tags on an Amazon DocumentDB resource. 309 */ 310 listTagsForResource(callback?: (err: AWSError, data: DocDB.Types.TagListMessage) => void): Request<DocDB.Types.TagListMessage, AWSError>; 311 /** 312 * Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. 313 */ 314 modifyDBCluster(params: DocDB.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterResult) => void): Request<DocDB.Types.ModifyDBClusterResult, AWSError>; 315 /** 316 * Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. 317 */ 318 modifyDBCluster(callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterResult) => void): Request<DocDB.Types.ModifyDBClusterResult, AWSError>; 319 /** 320 * Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect. After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter. 321 */ 322 modifyDBClusterParameterGroup(params: DocDB.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request<DocDB.Types.DBClusterParameterGroupNameMessage, AWSError>; 323 /** 324 * Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect. After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter. 325 */ 326 modifyDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request<DocDB.Types.DBClusterParameterGroupNameMessage, AWSError>; 327 /** 328 * Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot. To share a manual cluster snapshot with other accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. 329 */ 330 modifyDBClusterSnapshotAttribute(params: DocDB.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<DocDB.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>; 331 /** 332 * Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot. To share a manual cluster snapshot with other accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. 333 */ 334 modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<DocDB.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>; 335 /** 336 * Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. 337 */ 338 modifyDBInstance(params: DocDB.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBInstanceResult) => void): Request<DocDB.Types.ModifyDBInstanceResult, AWSError>; 339 /** 340 * Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. 341 */ 342 modifyDBInstance(callback?: (err: AWSError, data: DocDB.Types.ModifyDBInstanceResult) => void): Request<DocDB.Types.ModifyDBInstanceResult, AWSError>; 343 /** 344 * Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region. 345 */ 346 modifyDBSubnetGroup(params: DocDB.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBSubnetGroupResult) => void): Request<DocDB.Types.ModifyDBSubnetGroupResult, AWSError>; 347 /** 348 * Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region. 349 */ 350 modifyDBSubnetGroup(callback?: (err: AWSError, data: DocDB.Types.ModifyDBSubnetGroupResult) => void): Request<DocDB.Types.ModifyDBSubnetGroupResult, AWSError>; 351 /** 352 * Modifies an existing Amazon DocumentDB event notification subscription. 353 */ 354 modifyEventSubscription(params: DocDB.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyEventSubscriptionResult) => void): Request<DocDB.Types.ModifyEventSubscriptionResult, AWSError>; 355 /** 356 * Modifies an existing Amazon DocumentDB event notification subscription. 357 */ 358 modifyEventSubscription(callback?: (err: AWSError, data: DocDB.Types.ModifyEventSubscriptionResult) => void): Request<DocDB.Types.ModifyEventSubscriptionResult, AWSError>; 359 /** 360 * Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request. This action only applies to Amazon DocumentDB clusters. 361 */ 362 modifyGlobalCluster(params: DocDB.Types.ModifyGlobalClusterMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyGlobalClusterResult) => void): Request<DocDB.Types.ModifyGlobalClusterResult, AWSError>; 363 /** 364 * Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request. This action only applies to Amazon DocumentDB clusters. 365 */ 366 modifyGlobalCluster(callback?: (err: AWSError, data: DocDB.Types.ModifyGlobalClusterResult) => void): Request<DocDB.Types.ModifyGlobalClusterResult, AWSError>; 367 /** 368 * You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting. 369 */ 370 rebootDBInstance(params: DocDB.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.RebootDBInstanceResult) => void): Request<DocDB.Types.RebootDBInstanceResult, AWSError>; 371 /** 372 * You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting. 373 */ 374 rebootDBInstance(callback?: (err: AWSError, data: DocDB.Types.RebootDBInstanceResult) => void): Request<DocDB.Types.RebootDBInstanceResult, AWSError>; 375 /** 376 * Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region. This action only applies to Amazon DocumentDB clusters. 377 */ 378 removeFromGlobalCluster(params: DocDB.Types.RemoveFromGlobalClusterMessage, callback?: (err: AWSError, data: DocDB.Types.RemoveFromGlobalClusterResult) => void): Request<DocDB.Types.RemoveFromGlobalClusterResult, AWSError>; 379 /** 380 * Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region. This action only applies to Amazon DocumentDB clusters. 381 */ 382 removeFromGlobalCluster(callback?: (err: AWSError, data: DocDB.Types.RemoveFromGlobalClusterResult) => void): Request<DocDB.Types.RemoveFromGlobalClusterResult, AWSError>; 383 /** 384 * Removes a source identifier from an existing Amazon DocumentDB event notification subscription. 385 */ 386 removeSourceIdentifierFromSubscription(params: DocDB.Types.RemoveSourceIdentifierFromSubscriptionMessage, callback?: (err: AWSError, data: DocDB.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<DocDB.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>; 387 /** 388 * Removes a source identifier from an existing Amazon DocumentDB event notification subscription. 389 */ 390 removeSourceIdentifierFromSubscription(callback?: (err: AWSError, data: DocDB.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<DocDB.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>; 391 /** 392 * Removes metadata tags from an Amazon DocumentDB resource. 393 */ 394 removeTagsFromResource(params: DocDB.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 395 /** 396 * Removes metadata tags from an Amazon DocumentDB resource. 397 */ 398 removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 399 /** 400 * Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot. 401 */ 402 resetDBClusterParameterGroup(params: DocDB.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request<DocDB.Types.DBClusterParameterGroupNameMessage, AWSError>; 403 /** 404 * Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot. 405 */ 406 resetDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request<DocDB.Types.DBClusterParameterGroupNameMessage, AWSError>; 407 /** 408 * Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group. If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group. 409 */ 410 restoreDBClusterFromSnapshot(params: DocDB.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterFromSnapshotResult) => void): Request<DocDB.Types.RestoreDBClusterFromSnapshotResult, AWSError>; 411 /** 412 * Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group. If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group. 413 */ 414 restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterFromSnapshotResult) => void): Request<DocDB.Types.RestoreDBClusterFromSnapshotResult, AWSError>; 415 /** 416 * Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group. 417 */ 418 restoreDBClusterToPointInTime(params: DocDB.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterToPointInTimeResult) => void): Request<DocDB.Types.RestoreDBClusterToPointInTimeResult, AWSError>; 419 /** 420 * Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group. 421 */ 422 restoreDBClusterToPointInTime(callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterToPointInTimeResult) => void): Request<DocDB.Types.RestoreDBClusterToPointInTimeResult, AWSError>; 423 /** 424 * Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster. 425 */ 426 startDBCluster(params: DocDB.Types.StartDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.StartDBClusterResult) => void): Request<DocDB.Types.StartDBClusterResult, AWSError>; 427 /** 428 * Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster. 429 */ 430 startDBCluster(callback?: (err: AWSError, data: DocDB.Types.StartDBClusterResult) => void): Request<DocDB.Types.StartDBClusterResult, AWSError>; 431 /** 432 * Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster. 433 */ 434 stopDBCluster(params: DocDB.Types.StopDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.StopDBClusterResult) => void): Request<DocDB.Types.StopDBClusterResult, AWSError>; 435 /** 436 * Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster. 437 */ 438 stopDBCluster(callback?: (err: AWSError, data: DocDB.Types.StopDBClusterResult) => void): Request<DocDB.Types.StopDBClusterResult, AWSError>; 439 /** 440 * Waits for the dBInstanceAvailable state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times). 441 */ 442 waitFor(state: "dBInstanceAvailable", params: DocDB.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>; 443 /** 444 * Waits for the dBInstanceAvailable state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times). 445 */ 446 waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>; 447 /** 448 * Waits for the dBInstanceDeleted state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times). 449 */ 450 waitFor(state: "dBInstanceDeleted", params: DocDB.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>; 451 /** 452 * Waits for the dBInstanceDeleted state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times). 453 */ 454 waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>; 455 } 456 declare namespace DocDB { 457 export interface AddSourceIdentifierToSubscriptionMessage { 458 /** 459 * The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to. 460 */ 461 SubscriptionName: String; 462 /** 463 * 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. 464 */ 465 SourceIdentifier: String; 466 } 467 export interface AddSourceIdentifierToSubscriptionResult { 468 EventSubscription?: EventSubscription; 469 } 470 export interface AddTagsToResourceMessage { 471 /** 472 * The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name . 473 */ 474 ResourceName: String; 475 /** 476 * The tags to be assigned to the Amazon DocumentDB resource. 477 */ 478 Tags: TagList; 479 } 480 export type ApplyMethod = "immediate"|"pending-reboot"|string; 481 export interface ApplyPendingMaintenanceActionMessage { 482 /** 483 * The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. 484 */ 485 ResourceIdentifier: String; 486 /** 487 * The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade 488 */ 489 ApplyAction: String; 490 /** 491 * 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. 492 */ 493 OptInType: String; 494 } 495 export interface ApplyPendingMaintenanceActionResult { 496 ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions; 497 } 498 export type AttributeValueList = String[]; 499 export interface AvailabilityZone { 500 /** 501 * The name of the Availability Zone. 502 */ 503 Name?: String; 504 } 505 export type AvailabilityZoneList = AvailabilityZone[]; 506 export type AvailabilityZones = String[]; 507 export type Boolean = boolean; 508 export type BooleanOptional = boolean; 509 export interface Certificate { 510 /** 511 * The unique key that identifies a certificate. Example: rds-ca-2019 512 */ 513 CertificateIdentifier?: String; 514 /** 515 * The type of the certificate. Example: CA 516 */ 517 CertificateType?: String; 518 /** 519 * The thumbprint of the certificate. 520 */ 521 Thumbprint?: String; 522 /** 523 * The starting date-time from which the certificate is valid. Example: 2019-07-31T17:57:09Z 524 */ 525 ValidFrom?: TStamp; 526 /** 527 * The date-time after which the certificate is no longer valid. Example: 2024-07-31T17:57:09Z 528 */ 529 ValidTill?: TStamp; 530 /** 531 * The Amazon Resource Name (ARN) for the certificate. Example: arn:aws:rds:us-east-1::cert:rds-ca-2019 532 */ 533 CertificateArn?: String; 534 } 535 export type CertificateList = Certificate[]; 536 export interface CertificateMessage { 537 /** 538 * A list of certificates for this account. 539 */ 540 Certificates?: CertificateList; 541 /** 542 * 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. 543 */ 544 Marker?: String; 545 } 546 export interface CloudwatchLogsExportConfiguration { 547 /** 548 * The list of log types to enable. 549 */ 550 EnableLogTypes?: LogTypeList; 551 /** 552 * The list of log types to disable. 553 */ 554 DisableLogTypes?: LogTypeList; 555 } 556 export interface CopyDBClusterParameterGroupMessage { 557 /** 558 * 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. 559 */ 560 SourceDBClusterParameterGroupIdentifier: String; 561 /** 562 * 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 563 */ 564 TargetDBClusterParameterGroupIdentifier: String; 565 /** 566 * A description for the copied cluster parameter group. 567 */ 568 TargetDBClusterParameterGroupDescription: String; 569 /** 570 * The tags that are to be assigned to the parameter group. 571 */ 572 Tags?: TagList; 573 } 574 export interface CopyDBClusterParameterGroupResult { 575 DBClusterParameterGroup?: DBClusterParameterGroup; 576 } 577 export interface CopyDBClusterSnapshotMessage { 578 /** 579 * 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 580 */ 581 SourceDBClusterSnapshotIdentifier: String; 582 /** 583 * 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 584 */ 585 TargetDBClusterSnapshotIdentifier: String; 586 /** 587 * 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. 588 */ 589 KmsKeyId?: String; 590 /** 591 * 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. 592 */ 593 PreSignedUrl?: String; 594 /** 595 * Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false. 596 */ 597 CopyTags?: BooleanOptional; 598 /** 599 * The tags to be assigned to the cluster snapshot. 600 */ 601 Tags?: TagList; 602 } 603 export interface CopyDBClusterSnapshotResult { 604 DBClusterSnapshot?: DBClusterSnapshot; 605 } 606 export interface CreateDBClusterMessage { 607 /** 608 * A list of Amazon EC2 Availability Zones that instances in the cluster can be created in. 609 */ 610 AvailabilityZones?: AvailabilityZones; 611 /** 612 * 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. 613 */ 614 BackupRetentionPeriod?: IntegerOptional; 615 /** 616 * 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 617 */ 618 DBClusterIdentifier: String; 619 /** 620 * The name of the cluster parameter group to associate with this cluster. 621 */ 622 DBClusterParameterGroupName?: String; 623 /** 624 * A list of EC2 VPC security groups to associate with this cluster. 625 */ 626 VpcSecurityGroupIds?: VpcSecurityGroupIdList; 627 /** 628 * A subnet group to associate with this cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup 629 */ 630 DBSubnetGroupName?: String; 631 /** 632 * The name of the database engine to be used for this cluster. Valid values: docdb 633 */ 634 Engine: String; 635 /** 636 * 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. 637 */ 638 EngineVersion?: String; 639 /** 640 * The port number on which the instances in the cluster accept connections. 641 */ 642 Port?: IntegerOptional; 643 /** 644 * 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. 645 */ 646 MasterUsername?: String; 647 /** 648 * 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. 649 */ 650 MasterUserPassword?: String; 651 /** 652 * 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. 653 */ 654 PreferredBackupWindow?: String; 655 /** 656 * 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. 657 */ 658 PreferredMaintenanceWindow?: String; 659 /** 660 * The tags to be assigned to the cluster. 661 */ 662 Tags?: TagList; 663 /** 664 * Specifies whether the cluster is encrypted. 665 */ 666 StorageEncrypted?: BooleanOptional; 667 /** 668 * 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. 669 */ 670 KmsKeyId?: String; 671 /** 672 * Not currently supported. 673 */ 674 PreSignedUrl?: String; 675 /** 676 * 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. 677 */ 678 EnableCloudwatchLogsExports?: LogTypeList; 679 /** 680 * 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. 681 */ 682 DeletionProtection?: BooleanOptional; 683 /** 684 * The cluster identifier of the new global cluster. 685 */ 686 GlobalClusterIdentifier?: GlobalClusterIdentifier; 687 } 688 export interface CreateDBClusterParameterGroupMessage { 689 /** 690 * 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. 691 */ 692 DBClusterParameterGroupName: String; 693 /** 694 * The cluster parameter group family name. 695 */ 696 DBParameterGroupFamily: String; 697 /** 698 * The description for the cluster parameter group. 699 */ 700 Description: String; 701 /** 702 * The tags to be assigned to the cluster parameter group. 703 */ 704 Tags?: TagList; 705 } 706 export interface CreateDBClusterParameterGroupResult { 707 DBClusterParameterGroup?: DBClusterParameterGroup; 708 } 709 export interface CreateDBClusterResult { 710 DBCluster?: DBCluster; 711 } 712 export interface CreateDBClusterSnapshotMessage { 713 /** 714 * 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 715 */ 716 DBClusterSnapshotIdentifier: String; 717 /** 718 * 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 719 */ 720 DBClusterIdentifier: String; 721 /** 722 * The tags to be assigned to the cluster snapshot. 723 */ 724 Tags?: TagList; 725 } 726 export interface CreateDBClusterSnapshotResult { 727 DBClusterSnapshot?: DBClusterSnapshot; 728 } 729 export interface CreateDBInstanceMessage { 730 /** 731 * 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 732 */ 733 DBInstanceIdentifier: String; 734 /** 735 * The compute and memory capacity of the instance; for example, db.r5.large. 736 */ 737 DBInstanceClass: String; 738 /** 739 * The name of the database engine to be used for this instance. Valid value: docdb 740 */ 741 Engine: String; 742 /** 743 * 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 744 */ 745 AvailabilityZone?: String; 746 /** 747 * 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. 748 */ 749 PreferredMaintenanceWindow?: String; 750 /** 751 * This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. Default: false 752 */ 753 AutoMinorVersionUpgrade?: BooleanOptional; 754 /** 755 * The tags to be assigned to the instance. You can assign up to 10 tags to an instance. 756 */ 757 Tags?: TagList; 758 /** 759 * The identifier of the cluster that the instance will belong to. 760 */ 761 DBClusterIdentifier: String; 762 /** 763 * 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 764 */ 765 PromotionTier?: IntegerOptional; 766 } 767 export interface CreateDBInstanceResult { 768 DBInstance?: DBInstance; 769 } 770 export interface CreateDBSubnetGroupMessage { 771 /** 772 * 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 773 */ 774 DBSubnetGroupName: String; 775 /** 776 * The description for the subnet group. 777 */ 778 DBSubnetGroupDescription: String; 779 /** 780 * The Amazon EC2 subnet IDs for the subnet group. 781 */ 782 SubnetIds: SubnetIdentifierList; 783 /** 784 * The tags to be assigned to the subnet group. 785 */ 786 Tags?: TagList; 787 } 788 export interface CreateDBSubnetGroupResult { 789 DBSubnetGroup?: DBSubnetGroup; 790 } 791 export interface CreateEventSubscriptionMessage { 792 /** 793 * The name of the subscription. Constraints: The name must be fewer than 255 characters. 794 */ 795 SubscriptionName: String; 796 /** 797 * 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. 798 */ 799 SnsTopicArn: String; 800 /** 801 * 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 802 */ 803 SourceType?: String; 804 /** 805 * A list of event categories for a SourceType that you want to subscribe to. 806 */ 807 EventCategories?: EventCategoriesList; 808 /** 809 * 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. 810 */ 811 SourceIds?: SourceIdsList; 812 /** 813 * A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. 814 */ 815 Enabled?: BooleanOptional; 816 /** 817 * The tags to be assigned to the event subscription. 818 */ 819 Tags?: TagList; 820 } 821 export interface CreateEventSubscriptionResult { 822 EventSubscription?: EventSubscription; 823 } 824 export interface CreateGlobalClusterMessage { 825 /** 826 * The cluster identifier of the new global cluster. 827 */ 828 GlobalClusterIdentifier: GlobalClusterIdentifier; 829 /** 830 * The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional. 831 */ 832 SourceDBClusterIdentifier?: String; 833 /** 834 * The name of the database engine to be used for this cluster. 835 */ 836 Engine?: String; 837 /** 838 * The engine version of the global cluster. 839 */ 840 EngineVersion?: String; 841 /** 842 * The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled. 843 */ 844 DeletionProtection?: BooleanOptional; 845 /** 846 * 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. 847 */ 848 DatabaseName?: String; 849 /** 850 * The storage encryption setting for the new global cluster. 851 */ 852 StorageEncrypted?: BooleanOptional; 853 } 854 export interface CreateGlobalClusterResult { 855 GlobalCluster?: GlobalCluster; 856 } 857 export interface DBCluster { 858 /** 859 * Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in. 860 */ 861 AvailabilityZones?: AvailabilityZones; 862 /** 863 * Specifies the number of days for which automatic snapshots are retained. 864 */ 865 BackupRetentionPeriod?: IntegerOptional; 866 /** 867 * Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster. 868 */ 869 DBClusterIdentifier?: String; 870 /** 871 * Specifies the name of the cluster parameter group for the cluster. 872 */ 873 DBClusterParameterGroup?: String; 874 /** 875 * Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group. 876 */ 877 DBSubnetGroup?: String; 878 /** 879 * Specifies the current state of this cluster. 880 */ 881 Status?: String; 882 /** 883 * Specifies the progress of the operation as a percentage. 884 */ 885 PercentProgress?: String; 886 /** 887 * The earliest time to which a database can be restored with point-in-time restore. 888 */ 889 EarliestRestorableTime?: TStamp; 890 /** 891 * Specifies the connection endpoint for the primary instance of the cluster. 892 */ 893 Endpoint?: String; 894 /** 895 * The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster. If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint. 896 */ 897 ReaderEndpoint?: String; 898 /** 899 * Specifies whether the cluster has instances in multiple Availability Zones. 900 */ 901 MultiAZ?: Boolean; 902 /** 903 * Provides the name of the database engine to be used for this cluster. 904 */ 905 Engine?: String; 906 /** 907 * Indicates the database engine version. 908 */ 909 EngineVersion?: String; 910 /** 911 * Specifies the latest time to which a database can be restored with point-in-time restore. 912 */ 913 LatestRestorableTime?: TStamp; 914 /** 915 * Specifies the port that the database engine is listening on. 916 */ 917 Port?: IntegerOptional; 918 /** 919 * Contains the master user name for the cluster. 920 */ 921 MasterUsername?: String; 922 /** 923 * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. 924 */ 925 PreferredBackupWindow?: String; 926 /** 927 * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 928 */ 929 PreferredMaintenanceWindow?: String; 930 /** 931 * Contains the identifier of the source cluster if this cluster is a secondary cluster. 932 */ 933 ReplicationSourceIdentifier?: String; 934 /** 935 * Contains one or more identifiers of the secondary clusters that are associated with this cluster. 936 */ 937 ReadReplicaIdentifiers?: ReadReplicaIdentifierList; 938 /** 939 * Provides the list of instances that make up the cluster. 940 */ 941 DBClusterMembers?: DBClusterMemberList; 942 /** 943 * Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to. 944 */ 945 VpcSecurityGroups?: VpcSecurityGroupMembershipList; 946 /** 947 * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. 948 */ 949 HostedZoneId?: String; 950 /** 951 * Specifies whether the cluster is encrypted. 952 */ 953 StorageEncrypted?: Boolean; 954 /** 955 * If StorageEncrypted is true, the KMS key identifier for the encrypted cluster. 956 */ 957 KmsKeyId?: String; 958 /** 959 * The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed. 960 */ 961 DbClusterResourceId?: String; 962 /** 963 * The Amazon Resource Name (ARN) for the cluster. 964 */ 965 DBClusterArn?: String; 966 /** 967 * Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf. 968 */ 969 AssociatedRoles?: DBClusterRoles; 970 /** 971 * Specifies the time when the cluster was created, in Universal Coordinated Time (UTC). 972 */ 973 ClusterCreateTime?: TStamp; 974 /** 975 * A list of log types that this cluster is configured to export to Amazon CloudWatch Logs. 976 */ 977 EnabledCloudwatchLogsExports?: LogTypeList; 978 /** 979 * 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. 980 */ 981 DeletionProtection?: Boolean; 982 } 983 export type DBClusterList = DBCluster[]; 984 export interface DBClusterMember { 985 /** 986 * Specifies the instance identifier for this member of the cluster. 987 */ 988 DBInstanceIdentifier?: String; 989 /** 990 * A value that is true if the cluster member is the primary instance for the cluster and false otherwise. 991 */ 992 IsClusterWriter?: Boolean; 993 /** 994 * Specifies the status of the cluster parameter group for this member of the DB cluster. 995 */ 996 DBClusterParameterGroupStatus?: String; 997 /** 998 * 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. 999 */ 1000 PromotionTier?: IntegerOptional; 1001 } 1002 export type DBClusterMemberList = DBClusterMember[]; 1003 export interface DBClusterMessage { 1004 /** 1005 * 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. 1006 */ 1007 Marker?: String; 1008 /** 1009 * A list of clusters. 1010 */ 1011 DBClusters?: DBClusterList; 1012 } 1013 export interface DBClusterParameterGroup { 1014 /** 1015 * Provides the name of the cluster parameter group. 1016 */ 1017 DBClusterParameterGroupName?: String; 1018 /** 1019 * Provides the name of the parameter group family that this cluster parameter group is compatible with. 1020 */ 1021 DBParameterGroupFamily?: String; 1022 /** 1023 * Provides the customer-specified description for this cluster parameter group. 1024 */ 1025 Description?: String; 1026 /** 1027 * The Amazon Resource Name (ARN) for the cluster parameter group. 1028 */ 1029 DBClusterParameterGroupArn?: String; 1030 } 1031 export interface DBClusterParameterGroupDetails { 1032 /** 1033 * Provides a list of parameters for the cluster parameter group. 1034 */ 1035 Parameters?: ParametersList; 1036 /** 1037 * 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. 1038 */ 1039 Marker?: String; 1040 } 1041 export type DBClusterParameterGroupList = DBClusterParameterGroup[]; 1042 export interface DBClusterParameterGroupNameMessage { 1043 /** 1044 * 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. 1045 */ 1046 DBClusterParameterGroupName?: String; 1047 } 1048 export interface DBClusterParameterGroupsMessage { 1049 /** 1050 * 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. 1051 */ 1052 Marker?: String; 1053 /** 1054 * A list of cluster parameter groups. 1055 */ 1056 DBClusterParameterGroups?: DBClusterParameterGroupList; 1057 } 1058 export interface DBClusterRole { 1059 /** 1060 * The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster. 1061 */ 1062 RoleArn?: String; 1063 /** 1064 * Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values: ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf. PENDING - The IAMrole ARN is being associated with the cluster. INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf. 1065 */ 1066 Status?: String; 1067 } 1068 export type DBClusterRoles = DBClusterRole[]; 1069 export interface DBClusterSnapshot { 1070 /** 1071 * Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in. 1072 */ 1073 AvailabilityZones?: AvailabilityZones; 1074 /** 1075 * Specifies the identifier for the cluster snapshot. 1076 */ 1077 DBClusterSnapshotIdentifier?: String; 1078 /** 1079 * Specifies the cluster identifier of the cluster that this cluster snapshot was created from. 1080 */ 1081 DBClusterIdentifier?: String; 1082 /** 1083 * Provides the time when the snapshot was taken, in UTC. 1084 */ 1085 SnapshotCreateTime?: TStamp; 1086 /** 1087 * Specifies the name of the database engine. 1088 */ 1089 Engine?: String; 1090 /** 1091 * Specifies the status of this cluster snapshot. 1092 */ 1093 Status?: String; 1094 /** 1095 * Specifies the port that the cluster was listening on at the time of the snapshot. 1096 */ 1097 Port?: Integer; 1098 /** 1099 * Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot. 1100 */ 1101 VpcId?: String; 1102 /** 1103 * Specifies the time when the cluster was created, in Universal Coordinated Time (UTC). 1104 */ 1105 ClusterCreateTime?: TStamp; 1106 /** 1107 * Provides the master user name for the cluster snapshot. 1108 */ 1109 MasterUsername?: String; 1110 /** 1111 * Provides the version of the database engine for this cluster snapshot. 1112 */ 1113 EngineVersion?: String; 1114 /** 1115 * Provides the type of the cluster snapshot. 1116 */ 1117 SnapshotType?: String; 1118 /** 1119 * Specifies the percentage of the estimated data that has been transferred. 1120 */ 1121 PercentProgress?: Integer; 1122 /** 1123 * Specifies whether the cluster snapshot is encrypted. 1124 */ 1125 StorageEncrypted?: Boolean; 1126 /** 1127 * If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot. 1128 */ 1129 KmsKeyId?: String; 1130 /** 1131 * The Amazon Resource Name (ARN) for the cluster snapshot. 1132 */ 1133 DBClusterSnapshotArn?: String; 1134 /** 1135 * If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value. 1136 */ 1137 SourceDBClusterSnapshotArn?: String; 1138 } 1139 export interface DBClusterSnapshotAttribute { 1140 /** 1141 * The name of the manual cluster snapshot attribute. The attribute named restore refers to the list of accounts that have permission to copy or restore the manual cluster snapshot. 1142 */ 1143 AttributeName?: String; 1144 /** 1145 * The values for the manual cluster snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any account to copy or restore. 1146 */ 1147 AttributeValues?: AttributeValueList; 1148 } 1149 export type DBClusterSnapshotAttributeList = DBClusterSnapshotAttribute[]; 1150 export interface DBClusterSnapshotAttributesResult { 1151 /** 1152 * The identifier of the cluster snapshot that the attributes apply to. 1153 */ 1154 DBClusterSnapshotIdentifier?: String; 1155 /** 1156 * The list of attributes and values for the cluster snapshot. 1157 */ 1158 DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList; 1159 } 1160 export type DBClusterSnapshotList = DBClusterSnapshot[]; 1161 export interface DBClusterSnapshotMessage { 1162 /** 1163 * 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. 1164 */ 1165 Marker?: String; 1166 /** 1167 * Provides a list of cluster snapshots. 1168 */ 1169 DBClusterSnapshots?: DBClusterSnapshotList; 1170 } 1171 export interface DBEngineVersion { 1172 /** 1173 * The name of the database engine. 1174 */ 1175 Engine?: String; 1176 /** 1177 * The version number of the database engine. 1178 */ 1179 EngineVersion?: String; 1180 /** 1181 * The name of the parameter group family for the database engine. 1182 */ 1183 DBParameterGroupFamily?: String; 1184 /** 1185 * The description of the database engine. 1186 */ 1187 DBEngineDescription?: String; 1188 /** 1189 * The description of the database engine version. 1190 */ 1191 DBEngineVersionDescription?: String; 1192 /** 1193 * A list of engine versions that this database engine version can be upgraded to. 1194 */ 1195 ValidUpgradeTarget?: ValidUpgradeTargetList; 1196 /** 1197 * The types of logs that the database engine has available for export to Amazon CloudWatch Logs. 1198 */ 1199 ExportableLogTypes?: LogTypeList; 1200 /** 1201 * A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs. 1202 */ 1203 SupportsLogExportsToCloudwatchLogs?: Boolean; 1204 } 1205 export type DBEngineVersionList = DBEngineVersion[]; 1206 export interface DBEngineVersionMessage { 1207 /** 1208 * 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. 1209 */ 1210 Marker?: String; 1211 /** 1212 * Detailed information about one or more engine versions. 1213 */ 1214 DBEngineVersions?: DBEngineVersionList; 1215 } 1216 export interface DBInstance { 1217 /** 1218 * Contains a user-provided database identifier. This identifier is the unique key that identifies an instance. 1219 */ 1220 DBInstanceIdentifier?: String; 1221 /** 1222 * Contains the name of the compute and memory capacity class of the instance. 1223 */ 1224 DBInstanceClass?: String; 1225 /** 1226 * Provides the name of the database engine to be used for this instance. 1227 */ 1228 Engine?: String; 1229 /** 1230 * Specifies the current state of this database. 1231 */ 1232 DBInstanceStatus?: String; 1233 /** 1234 * Specifies the connection endpoint. 1235 */ 1236 Endpoint?: Endpoint; 1237 /** 1238 * Provides the date and time that the instance was created. 1239 */ 1240 InstanceCreateTime?: TStamp; 1241 /** 1242 * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. 1243 */ 1244 PreferredBackupWindow?: String; 1245 /** 1246 * Specifies the number of days for which automatic snapshots are retained. 1247 */ 1248 BackupRetentionPeriod?: Integer; 1249 /** 1250 * Provides a list of VPC security group elements that the instance belongs to. 1251 */ 1252 VpcSecurityGroups?: VpcSecurityGroupMembershipList; 1253 /** 1254 * Specifies the name of the Availability Zone that the instance is located in. 1255 */ 1256 AvailabilityZone?: String; 1257 /** 1258 * Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group. 1259 */ 1260 DBSubnetGroup?: DBSubnetGroup; 1261 /** 1262 * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 1263 */ 1264 PreferredMaintenanceWindow?: String; 1265 /** 1266 * Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements. 1267 */ 1268 PendingModifiedValues?: PendingModifiedValues; 1269 /** 1270 * Specifies the latest time to which a database can be restored with point-in-time restore. 1271 */ 1272 LatestRestorableTime?: TStamp; 1273 /** 1274 * Indicates the database engine version. 1275 */ 1276 EngineVersion?: String; 1277 /** 1278 * Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. 1279 */ 1280 AutoMinorVersionUpgrade?: Boolean; 1281 /** 1282 * Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false. 1283 */ 1284 PubliclyAccessible?: Boolean; 1285 /** 1286 * The status of a read replica. If the instance is not a read replica, this is blank. 1287 */ 1288 StatusInfos?: DBInstanceStatusInfoList; 1289 /** 1290 * Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster. 1291 */ 1292 DBClusterIdentifier?: String; 1293 /** 1294 * Specifies whether or not the instance is encrypted. 1295 */ 1296 StorageEncrypted?: Boolean; 1297 /** 1298 * If StorageEncrypted is true, the KMS key identifier for the encrypted instance. 1299 */ 1300 KmsKeyId?: String; 1301 /** 1302 * The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed. 1303 */ 1304 DbiResourceId?: String; 1305 /** 1306 * The identifier of the CA certificate for this DB instance. 1307 */ 1308 CACertificateIdentifier?: String; 1309 /** 1310 * 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. 1311 */ 1312 PromotionTier?: IntegerOptional; 1313 /** 1314 * The Amazon Resource Name (ARN) for the instance. 1315 */ 1316 DBInstanceArn?: String; 1317 /** 1318 * A list of log types that this instance is configured to export to CloudWatch Logs. 1319 */ 1320 EnabledCloudwatchLogsExports?: LogTypeList; 1321 } 1322 export type DBInstanceList = DBInstance[]; 1323 export interface DBInstanceMessage { 1324 /** 1325 * 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. 1326 */ 1327 Marker?: String; 1328 /** 1329 * Detailed information about one or more instances. 1330 */ 1331 DBInstances?: DBInstanceList; 1332 } 1333 export interface DBInstanceStatusInfo { 1334 /** 1335 * This value is currently "read replication." 1336 */ 1337 StatusType?: String; 1338 /** 1339 * A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. 1340 */ 1341 Normal?: Boolean; 1342 /** 1343 * Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated. 1344 */ 1345 Status?: String; 1346 /** 1347 * Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank. 1348 */ 1349 Message?: String; 1350 } 1351 export type DBInstanceStatusInfoList = DBInstanceStatusInfo[]; 1352 export interface DBSubnetGroup { 1353 /** 1354 * The name of the subnet group. 1355 */ 1356 DBSubnetGroupName?: String; 1357 /** 1358 * Provides the description of the subnet group. 1359 */ 1360 DBSubnetGroupDescription?: String; 1361 /** 1362 * Provides the virtual private cloud (VPC) ID of the subnet group. 1363 */ 1364 VpcId?: String; 1365 /** 1366 * Provides the status of the subnet group. 1367 */ 1368 SubnetGroupStatus?: String; 1369 /** 1370 * Detailed information about one or more subnets within a subnet group. 1371 */ 1372 Subnets?: SubnetList; 1373 /** 1374 * The Amazon Resource Name (ARN) for the DB subnet group. 1375 */ 1376 DBSubnetGroupArn?: String; 1377 } 1378 export interface DBSubnetGroupMessage { 1379 /** 1380 * 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. 1381 */ 1382 Marker?: String; 1383 /** 1384 * Detailed information about one or more subnet groups. 1385 */ 1386 DBSubnetGroups?: DBSubnetGroups; 1387 } 1388 export type DBSubnetGroups = DBSubnetGroup[]; 1389 export interface DeleteDBClusterMessage { 1390 /** 1391 * The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive. Constraints: Must match an existing DBClusterIdentifier. 1392 */ 1393 DBClusterIdentifier: String; 1394 /** 1395 * 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 1396 */ 1397 SkipFinalSnapshot?: Boolean; 1398 /** 1399 * 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. 1400 */ 1401 FinalDBSnapshotIdentifier?: String; 1402 } 1403 export interface DeleteDBClusterParameterGroupMessage { 1404 /** 1405 * 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. 1406 */ 1407 DBClusterParameterGroupName: String; 1408 } 1409 export interface DeleteDBClusterResult { 1410 DBCluster?: DBCluster; 1411 } 1412 export interface DeleteDBClusterSnapshotMessage { 1413 /** 1414 * The identifier of the cluster snapshot to delete. Constraints: Must be the name of an existing cluster snapshot in the available state. 1415 */ 1416 DBClusterSnapshotIdentifier: String; 1417 } 1418 export interface DeleteDBClusterSnapshotResult { 1419 DBClusterSnapshot?: DBClusterSnapshot; 1420 } 1421 export interface DeleteDBInstanceMessage { 1422 /** 1423 * The instance identifier for the instance to be deleted. This parameter isn't case sensitive. Constraints: Must match the name of an existing instance. 1424 */ 1425 DBInstanceIdentifier: String; 1426 } 1427 export interface DeleteDBInstanceResult { 1428 DBInstance?: DBInstance; 1429 } 1430 export interface DeleteDBSubnetGroupMessage { 1431 /** 1432 * 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 1433 */ 1434 DBSubnetGroupName: String; 1435 } 1436 export interface DeleteEventSubscriptionMessage { 1437 /** 1438 * The name of the Amazon DocumentDB event notification subscription that you want to delete. 1439 */ 1440 SubscriptionName: String; 1441 } 1442 export interface DeleteEventSubscriptionResult { 1443 EventSubscription?: EventSubscription; 1444 } 1445 export interface DeleteGlobalClusterMessage { 1446 /** 1447 * The cluster identifier of the global cluster being deleted. 1448 */ 1449 GlobalClusterIdentifier: GlobalClusterIdentifier; 1450 } 1451 export interface DeleteGlobalClusterResult { 1452 GlobalCluster?: GlobalCluster; 1453 } 1454 export interface DescribeCertificatesMessage { 1455 /** 1456 * 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. 1457 */ 1458 CertificateIdentifier?: String; 1459 /** 1460 * This parameter is not currently supported. 1461 */ 1462 Filters?: FilterList; 1463 /** 1464 * 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 1465 */ 1466 MaxRecords?: IntegerOptional; 1467 /** 1468 * 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. 1469 */ 1470 Marker?: String; 1471 } 1472 export interface DescribeDBClusterParameterGroupsMessage { 1473 /** 1474 * The name of a specific cluster parameter group to return details for. Constraints: If provided, must match the name of an existing DBClusterParameterGroup. 1475 */ 1476 DBClusterParameterGroupName?: String; 1477 /** 1478 * This parameter is not currently supported. 1479 */ 1480 Filters?: FilterList; 1481 /** 1482 * 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. 1483 */ 1484 MaxRecords?: IntegerOptional; 1485 /** 1486 * 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. 1487 */ 1488 Marker?: String; 1489 } 1490 export interface DescribeDBClusterParametersMessage { 1491 /** 1492 * The name of a specific cluster parameter group to return parameter details for. Constraints: If provided, must match the name of an existing DBClusterParameterGroup. 1493 */ 1494 DBClusterParameterGroupName: String; 1495 /** 1496 * A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer. 1497 */ 1498 Source?: String; 1499 /** 1500 * This parameter is not currently supported. 1501 */ 1502 Filters?: FilterList; 1503 /** 1504 * 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. 1505 */ 1506 MaxRecords?: IntegerOptional; 1507 /** 1508 * 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. 1509 */ 1510 Marker?: String; 1511 } 1512 export interface DescribeDBClusterSnapshotAttributesMessage { 1513 /** 1514 * The identifier for the cluster snapshot to describe the attributes for. 1515 */ 1516 DBClusterSnapshotIdentifier: String; 1517 } 1518 export interface DescribeDBClusterSnapshotAttributesResult { 1519 DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult; 1520 } 1521 export interface DescribeDBClusterSnapshotsMessage { 1522 /** 1523 * 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. 1524 */ 1525 DBClusterIdentifier?: String; 1526 /** 1527 * 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. 1528 */ 1529 DBClusterSnapshotIdentifier?: String; 1530 /** 1531 * 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. 1532 */ 1533 SnapshotType?: String; 1534 /** 1535 * This parameter is not currently supported. 1536 */ 1537 Filters?: FilterList; 1538 /** 1539 * 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. 1540 */ 1541 MaxRecords?: IntegerOptional; 1542 /** 1543 * 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. 1544 */ 1545 Marker?: String; 1546 /** 1547 * 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. 1548 */ 1549 IncludeShared?: Boolean; 1550 /** 1551 * 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. 1552 */ 1553 IncludePublic?: Boolean; 1554 } 1555 export interface DescribeDBClustersMessage { 1556 /** 1557 * 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. 1558 */ 1559 DBClusterIdentifier?: String; 1560 /** 1561 * 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. 1562 */ 1563 Filters?: FilterList; 1564 /** 1565 * 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. 1566 */ 1567 MaxRecords?: IntegerOptional; 1568 /** 1569 * 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. 1570 */ 1571 Marker?: String; 1572 } 1573 export interface DescribeDBEngineVersionsMessage { 1574 /** 1575 * The database engine to return. 1576 */ 1577 Engine?: String; 1578 /** 1579 * The database engine version to return. Example: 3.6.0 1580 */ 1581 EngineVersion?: String; 1582 /** 1583 * The name of a specific parameter group family to return details for. Constraints: If provided, must match an existing DBParameterGroupFamily. 1584 */ 1585 DBParameterGroupFamily?: String; 1586 /** 1587 * This parameter is not currently supported. 1588 */ 1589 Filters?: FilterList; 1590 /** 1591 * 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. 1592 */ 1593 MaxRecords?: IntegerOptional; 1594 /** 1595 * 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. 1596 */ 1597 Marker?: String; 1598 /** 1599 * Indicates that only the default version of the specified engine or engine and major version combination is returned. 1600 */ 1601 DefaultOnly?: Boolean; 1602 /** 1603 * 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. 1604 */ 1605 ListSupportedCharacterSets?: BooleanOptional; 1606 /** 1607 * 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. 1608 */ 1609 ListSupportedTimezones?: BooleanOptional; 1610 } 1611 export interface DescribeDBInstancesMessage { 1612 /** 1613 * 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. 1614 */ 1615 DBInstanceIdentifier?: String; 1616 /** 1617 * 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. 1618 */ 1619 Filters?: FilterList; 1620 /** 1621 * 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. 1622 */ 1623 MaxRecords?: IntegerOptional; 1624 /** 1625 * 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. 1626 */ 1627 Marker?: String; 1628 } 1629 export interface DescribeDBSubnetGroupsMessage { 1630 /** 1631 * The name of the subnet group to return details for. 1632 */ 1633 DBSubnetGroupName?: String; 1634 /** 1635 * This parameter is not currently supported. 1636 */ 1637 Filters?: FilterList; 1638 /** 1639 * 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. 1640 */ 1641 MaxRecords?: IntegerOptional; 1642 /** 1643 * 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. 1644 */ 1645 Marker?: String; 1646 } 1647 export interface DescribeEngineDefaultClusterParametersMessage { 1648 /** 1649 * The name of the cluster parameter group family to return the engine parameter information for. 1650 */ 1651 DBParameterGroupFamily: String; 1652 /** 1653 * This parameter is not currently supported. 1654 */ 1655 Filters?: FilterList; 1656 /** 1657 * 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. 1658 */ 1659 MaxRecords?: IntegerOptional; 1660 /** 1661 * 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. 1662 */ 1663 Marker?: String; 1664 } 1665 export interface DescribeEngineDefaultClusterParametersResult { 1666 EngineDefaults?: EngineDefaults; 1667 } 1668 export interface DescribeEventCategoriesMessage { 1669 /** 1670 * The type of source that is generating the events. Valid values: db-instance, db-parameter-group, db-security-group 1671 */ 1672 SourceType?: String; 1673 /** 1674 * This parameter is not currently supported. 1675 */ 1676 Filters?: FilterList; 1677 } 1678 export interface DescribeEventSubscriptionsMessage { 1679 /** 1680 * The name of the Amazon DocumentDB event notification subscription that you want to describe. 1681 */ 1682 SubscriptionName?: String; 1683 /** 1684 * This parameter is not currently supported. 1685 */ 1686 Filters?: FilterList; 1687 /** 1688 * 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. 1689 */ 1690 MaxRecords?: IntegerOptional; 1691 /** 1692 * 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. 1693 */ 1694 Marker?: String; 1695 } 1696 export interface DescribeEventsMessage { 1697 /** 1698 * 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. 1699 */ 1700 SourceIdentifier?: String; 1701 /** 1702 * The event source to retrieve events for. If no value is specified, all events are returned. 1703 */ 1704 SourceType?: SourceType; 1705 /** 1706 * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2009-07-08T18:00Z 1707 */ 1708 StartTime?: TStamp; 1709 /** 1710 * The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2009-07-08T18:00Z 1711 */ 1712 EndTime?: TStamp; 1713 /** 1714 * The number of minutes to retrieve events for. Default: 60 1715 */ 1716 Duration?: IntegerOptional; 1717 /** 1718 * A list of event categories that trigger notifications for an event notification subscription. 1719 */ 1720 EventCategories?: EventCategoriesList; 1721 /** 1722 * This parameter is not currently supported. 1723 */ 1724 Filters?: FilterList; 1725 /** 1726 * 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. 1727 */ 1728 MaxRecords?: IntegerOptional; 1729 /** 1730 * 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. 1731 */ 1732 Marker?: String; 1733 } 1734 export interface DescribeGlobalClustersMessage { 1735 /** 1736 * The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive. 1737 */ 1738 GlobalClusterIdentifier?: GlobalClusterIdentifier; 1739 /** 1740 * 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. 1741 */ 1742 Filters?: FilterList; 1743 /** 1744 * 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. 1745 */ 1746 MaxRecords?: IntegerOptional; 1747 /** 1748 * 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. 1749 */ 1750 Marker?: String; 1751 } 1752 export interface DescribeOrderableDBInstanceOptionsMessage { 1753 /** 1754 * The name of the engine to retrieve instance options for. 1755 */ 1756 Engine: String; 1757 /** 1758 * The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version. 1759 */ 1760 EngineVersion?: String; 1761 /** 1762 * The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class. 1763 */ 1764 DBInstanceClass?: String; 1765 /** 1766 * The license model filter value. Specify this parameter to show only the available offerings that match the specified license model. 1767 */ 1768 LicenseModel?: String; 1769 /** 1770 * The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings. 1771 */ 1772 Vpc?: BooleanOptional; 1773 /** 1774 * This parameter is not currently supported. 1775 */ 1776 Filters?: FilterList; 1777 /** 1778 * 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. 1779 */ 1780 MaxRecords?: IntegerOptional; 1781 /** 1782 * 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. 1783 */ 1784 Marker?: String; 1785 } 1786 export interface DescribePendingMaintenanceActionsMessage { 1787 /** 1788 * The ARN of a resource to return pending maintenance actions for. 1789 */ 1790 ResourceIdentifier?: String; 1791 /** 1792 * 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. 1793 */ 1794 Filters?: FilterList; 1795 /** 1796 * 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. 1797 */ 1798 Marker?: String; 1799 /** 1800 * 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. 1801 */ 1802 MaxRecords?: IntegerOptional; 1803 } 1804 export interface Endpoint { 1805 /** 1806 * Specifies the DNS address of the instance. 1807 */ 1808 Address?: String; 1809 /** 1810 * Specifies the port that the database engine is listening on. 1811 */ 1812 Port?: Integer; 1813 /** 1814 * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. 1815 */ 1816 HostedZoneId?: String; 1817 } 1818 export interface EngineDefaults { 1819 /** 1820 * The name of the cluster parameter group family to return the engine parameter information for. 1821 */ 1822 DBParameterGroupFamily?: String; 1823 /** 1824 * 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. 1825 */ 1826 Marker?: String; 1827 /** 1828 * The parameters of a particular cluster parameter group family. 1829 */ 1830 Parameters?: ParametersList; 1831 } 1832 export interface Event { 1833 /** 1834 * Provides the identifier for the source of the event. 1835 */ 1836 SourceIdentifier?: String; 1837 /** 1838 * Specifies the source type for this event. 1839 */ 1840 SourceType?: SourceType; 1841 /** 1842 * Provides the text of this event. 1843 */ 1844 Message?: String; 1845 /** 1846 * Specifies the category for the event. 1847 */ 1848 EventCategories?: EventCategoriesList; 1849 /** 1850 * Specifies the date and time of the event. 1851 */ 1852 Date?: TStamp; 1853 /** 1854 * The Amazon Resource Name (ARN) for the event. 1855 */ 1856 SourceArn?: String; 1857 } 1858 export type EventCategoriesList = String[]; 1859 export interface EventCategoriesMap { 1860 /** 1861 * The source type that the returned categories belong to. 1862 */ 1863 SourceType?: String; 1864 /** 1865 * The event categories for the specified source type. 1866 */ 1867 EventCategories?: EventCategoriesList; 1868 } 1869 export type EventCategoriesMapList = EventCategoriesMap[]; 1870 export interface EventCategoriesMessage { 1871 /** 1872 * A list of event category maps. 1873 */ 1874 EventCategoriesMapList?: EventCategoriesMapList; 1875 } 1876 export type EventList = Event[]; 1877 export interface EventSubscription { 1878 /** 1879 * The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription. 1880 */ 1881 CustomerAwsId?: String; 1882 /** 1883 * The Amazon DocumentDB event notification subscription ID. 1884 */ 1885 CustSubscriptionId?: String; 1886 /** 1887 * The topic ARN of the Amazon DocumentDB event notification subscription. 1888 */ 1889 SnsTopicArn?: String; 1890 /** 1891 * The status of the Amazon DocumentDB event notification subscription. Constraints: Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created. 1892 */ 1893 Status?: String; 1894 /** 1895 * The time at which the Amazon DocumentDB event notification subscription was created. 1896 */ 1897 SubscriptionCreationTime?: String; 1898 /** 1899 * The source type for the Amazon DocumentDB event notification subscription. 1900 */ 1901 SourceType?: String; 1902 /** 1903 * A list of source IDs for the Amazon DocumentDB event notification subscription. 1904 */ 1905 SourceIdsList?: SourceIdsList; 1906 /** 1907 * A list of event categories for the Amazon DocumentDB event notification subscription. 1908 */ 1909 EventCategoriesList?: EventCategoriesList; 1910 /** 1911 * A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled. 1912 */ 1913 Enabled?: Boolean; 1914 /** 1915 * The Amazon Resource Name (ARN) for the event subscription. 1916 */ 1917 EventSubscriptionArn?: String; 1918 } 1919 export type EventSubscriptionsList = EventSubscription[]; 1920 export interface EventSubscriptionsMessage { 1921 /** 1922 * 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. 1923 */ 1924 Marker?: String; 1925 /** 1926 * A list of event subscriptions. 1927 */ 1928 EventSubscriptionsList?: EventSubscriptionsList; 1929 } 1930 export interface EventsMessage { 1931 /** 1932 * 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. 1933 */ 1934 Marker?: String; 1935 /** 1936 * Detailed information about one or more events. 1937 */ 1938 Events?: EventList; 1939 } 1940 export interface FailoverDBClusterMessage { 1941 /** 1942 * A cluster identifier to force a failover for. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster. 1943 */ 1944 DBClusterIdentifier?: String; 1945 /** 1946 * 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. 1947 */ 1948 TargetDBInstanceIdentifier?: String; 1949 } 1950 export interface FailoverDBClusterResult { 1951 DBCluster?: DBCluster; 1952 } 1953 export interface Filter { 1954 /** 1955 * The name of the filter. Filter names are case sensitive. 1956 */ 1957 Name: String; 1958 /** 1959 * One or more filter values. Filter values are case sensitive. 1960 */ 1961 Values: FilterValueList; 1962 } 1963 export type FilterList = Filter[]; 1964 export type FilterValueList = String[]; 1965 export interface GlobalCluster { 1966 /** 1967 * Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster. 1968 */ 1969 GlobalClusterIdentifier?: GlobalClusterIdentifier; 1970 /** 1971 * The Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed. 1972 */ 1973 GlobalClusterResourceId?: String; 1974 /** 1975 * The Amazon Resource Name (ARN) for the global cluster. 1976 */ 1977 GlobalClusterArn?: String; 1978 /** 1979 * Specifies the current state of this global cluster. 1980 */ 1981 Status?: String; 1982 /** 1983 * The Amazon DocumentDB database engine used by the global cluster. 1984 */ 1985 Engine?: String; 1986 /** 1987 * Indicates the database engine version. 1988 */ 1989 EngineVersion?: String; 1990 /** 1991 * The default database name within the new global cluster. 1992 */ 1993 DatabaseName?: String; 1994 /** 1995 * The storage encryption setting for the global cluster. 1996 */ 1997 StorageEncrypted?: BooleanOptional; 1998 /** 1999 * The deletion protection setting for the new global cluster. 2000 */ 2001 DeletionProtection?: BooleanOptional; 2002 /** 2003 * The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item. 2004 */ 2005 GlobalClusterMembers?: GlobalClusterMemberList; 2006 } 2007 export type GlobalClusterIdentifier = string; 2008 export type GlobalClusterList = GlobalCluster[]; 2009 export interface GlobalClusterMember { 2010 /** 2011 * The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster. 2012 */ 2013 DBClusterArn?: String; 2014 /** 2015 * The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster. 2016 */ 2017 Readers?: ReadersArnList; 2018 /** 2019 * Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated. 2020 */ 2021 IsWriter?: Boolean; 2022 } 2023 export type GlobalClusterMemberList = GlobalClusterMember[]; 2024 export interface GlobalClustersMessage { 2025 /** 2026 * 2027 */ 2028 Marker?: String; 2029 /** 2030 * 2031 */ 2032 GlobalClusters?: GlobalClusterList; 2033 } 2034 export type Integer = number; 2035 export type IntegerOptional = number; 2036 export type KeyList = String[]; 2037 export interface ListTagsForResourceMessage { 2038 /** 2039 * The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN). 2040 */ 2041 ResourceName: String; 2042 /** 2043 * This parameter is not currently supported. 2044 */ 2045 Filters?: FilterList; 2046 } 2047 export type LogTypeList = String[]; 2048 export interface ModifyDBClusterMessage { 2049 /** 2050 * 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. 2051 */ 2052 DBClusterIdentifier: String; 2053 /** 2054 * 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 2055 */ 2056 NewDBClusterIdentifier?: String; 2057 /** 2058 * 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 2059 */ 2060 ApplyImmediately?: Boolean; 2061 /** 2062 * 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. 2063 */ 2064 BackupRetentionPeriod?: IntegerOptional; 2065 /** 2066 * The name of the cluster parameter group to use for the cluster. 2067 */ 2068 DBClusterParameterGroupName?: String; 2069 /** 2070 * A list of virtual private cloud (VPC) security groups that the cluster will belong to. 2071 */ 2072 VpcSecurityGroupIds?: VpcSecurityGroupIdList; 2073 /** 2074 * 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. 2075 */ 2076 Port?: IntegerOptional; 2077 /** 2078 * 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. 2079 */ 2080 MasterUserPassword?: String; 2081 /** 2082 * 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. 2083 */ 2084 PreferredBackupWindow?: String; 2085 /** 2086 * 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. 2087 */ 2088 PreferredMaintenanceWindow?: String; 2089 /** 2090 * 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. 2091 */ 2092 CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration; 2093 /** 2094 * The version number of the database engine to which you want to upgrade. Modifying engine version is not supported on Amazon DocumentDB. 2095 */ 2096 EngineVersion?: String; 2097 /** 2098 * 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. 2099 */ 2100 DeletionProtection?: BooleanOptional; 2101 } 2102 export interface ModifyDBClusterParameterGroupMessage { 2103 /** 2104 * The name of the cluster parameter group to modify. 2105 */ 2106 DBClusterParameterGroupName: String; 2107 /** 2108 * A list of parameters in the cluster parameter group to modify. 2109 */ 2110 Parameters: ParametersList; 2111 } 2112 export interface ModifyDBClusterResult { 2113 DBCluster?: DBCluster; 2114 } 2115 export interface ModifyDBClusterSnapshotAttributeMessage { 2116 /** 2117 * The identifier for the cluster snapshot to modify the attributes for. 2118 */ 2119 DBClusterSnapshotIdentifier: String; 2120 /** 2121 * 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. 2122 */ 2123 AttributeName: String; 2124 /** 2125 * 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. 2126 */ 2127 ValuesToAdd?: AttributeValueList; 2128 /** 2129 * 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. 2130 */ 2131 ValuesToRemove?: AttributeValueList; 2132 } 2133 export interface ModifyDBClusterSnapshotAttributeResult { 2134 DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult; 2135 } 2136 export interface ModifyDBInstanceMessage { 2137 /** 2138 * The instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance. 2139 */ 2140 DBInstanceIdentifier: String; 2141 /** 2142 * 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. 2143 */ 2144 DBInstanceClass?: String; 2145 /** 2146 * 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 2147 */ 2148 ApplyImmediately?: Boolean; 2149 /** 2150 * 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. 2151 */ 2152 PreferredMaintenanceWindow?: String; 2153 /** 2154 * This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. 2155 */ 2156 AutoMinorVersionUpgrade?: BooleanOptional; 2157 /** 2158 * 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 2159 */ 2160 NewDBInstanceIdentifier?: String; 2161 /** 2162 * Indicates the certificate that needs to be associated with the instance. 2163 */ 2164 CACertificateIdentifier?: String; 2165 /** 2166 * 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 2167 */ 2168 PromotionTier?: IntegerOptional; 2169 } 2170 export interface ModifyDBInstanceResult { 2171 DBInstance?: DBInstance; 2172 } 2173 export interface ModifyDBSubnetGroupMessage { 2174 /** 2175 * 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 2176 */ 2177 DBSubnetGroupName: String; 2178 /** 2179 * The description for the subnet group. 2180 */ 2181 DBSubnetGroupDescription?: String; 2182 /** 2183 * The Amazon EC2 subnet IDs for the subnet group. 2184 */ 2185 SubnetIds: SubnetIdentifierList; 2186 } 2187 export interface ModifyDBSubnetGroupResult { 2188 DBSubnetGroup?: DBSubnetGroup; 2189 } 2190 export interface ModifyEventSubscriptionMessage { 2191 /** 2192 * The name of the Amazon DocumentDB event notification subscription. 2193 */ 2194 SubscriptionName: String; 2195 /** 2196 * 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. 2197 */ 2198 SnsTopicArn?: String; 2199 /** 2200 * 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 2201 */ 2202 SourceType?: String; 2203 /** 2204 * A list of event categories for a SourceType that you want to subscribe to. 2205 */ 2206 EventCategories?: EventCategoriesList; 2207 /** 2208 * A Boolean value; set to true to activate the subscription. 2209 */ 2210 Enabled?: BooleanOptional; 2211 } 2212 export interface ModifyEventSubscriptionResult { 2213 EventSubscription?: EventSubscription; 2214 } 2215 export interface ModifyGlobalClusterMessage { 2216 /** 2217 * The identifier for the global cluster being modified. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing global cluster. 2218 */ 2219 GlobalClusterIdentifier: GlobalClusterIdentifier; 2220 /** 2221 * 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 2222 */ 2223 NewGlobalClusterIdentifier?: GlobalClusterIdentifier; 2224 /** 2225 * Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled. 2226 */ 2227 DeletionProtection?: BooleanOptional; 2228 } 2229 export interface ModifyGlobalClusterResult { 2230 GlobalCluster?: GlobalCluster; 2231 } 2232 export interface OrderableDBInstanceOption { 2233 /** 2234 * The engine type of an instance. 2235 */ 2236 Engine?: String; 2237 /** 2238 * The engine version of an instance. 2239 */ 2240 EngineVersion?: String; 2241 /** 2242 * The instance class for an instance. 2243 */ 2244 DBInstanceClass?: String; 2245 /** 2246 * The license model for an instance. 2247 */ 2248 LicenseModel?: String; 2249 /** 2250 * A list of Availability Zones for an instance. 2251 */ 2252 AvailabilityZones?: AvailabilityZoneList; 2253 /** 2254 * Indicates whether an instance is in a virtual private cloud (VPC). 2255 */ 2256 Vpc?: Boolean; 2257 } 2258 export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[]; 2259 export interface OrderableDBInstanceOptionsMessage { 2260 /** 2261 * The options that are available for a particular orderable instance. 2262 */ 2263 OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList; 2264 /** 2265 * 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. 2266 */ 2267 Marker?: String; 2268 } 2269 export interface Parameter { 2270 /** 2271 * Specifies the name of the parameter. 2272 */ 2273 ParameterName?: String; 2274 /** 2275 * Specifies the value of the parameter. 2276 */ 2277 ParameterValue?: String; 2278 /** 2279 * Provides a description of the parameter. 2280 */ 2281 Description?: String; 2282 /** 2283 * Indicates the source of the parameter value. 2284 */ 2285 Source?: String; 2286 /** 2287 * Specifies the engine-specific parameters type. 2288 */ 2289 ApplyType?: String; 2290 /** 2291 * Specifies the valid data type for the parameter. 2292 */ 2293 DataType?: String; 2294 /** 2295 * Specifies the valid range of values for the parameter. 2296 */ 2297 AllowedValues?: String; 2298 /** 2299 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. 2300 */ 2301 IsModifiable?: Boolean; 2302 /** 2303 * The earliest engine version to which the parameter can apply. 2304 */ 2305 MinimumEngineVersion?: String; 2306 /** 2307 * Indicates when to apply parameter updates. 2308 */ 2309 ApplyMethod?: ApplyMethod; 2310 } 2311 export type ParametersList = Parameter[]; 2312 export interface PendingCloudwatchLogsExports { 2313 /** 2314 * Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. 2315 */ 2316 LogTypesToEnable?: LogTypeList; 2317 /** 2318 * Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs. 2319 */ 2320 LogTypesToDisable?: LogTypeList; 2321 } 2322 export interface PendingMaintenanceAction { 2323 /** 2324 * The type of pending maintenance action that is available for the resource. 2325 */ 2326 Action?: String; 2327 /** 2328 * The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored. 2329 */ 2330 AutoAppliedAfterDate?: TStamp; 2331 /** 2332 * The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored. 2333 */ 2334 ForcedApplyDate?: TStamp; 2335 /** 2336 * Indicates the type of opt-in request that has been received for the resource. 2337 */ 2338 OptInStatus?: String; 2339 /** 2340 * The effective date when the pending maintenance action is applied to the resource. 2341 */ 2342 CurrentApplyDate?: TStamp; 2343 /** 2344 * A description providing more detail about the maintenance action. 2345 */ 2346 Description?: String; 2347 } 2348 export type PendingMaintenanceActionDetails = PendingMaintenanceAction[]; 2349 export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[]; 2350 export interface PendingMaintenanceActionsMessage { 2351 /** 2352 * The maintenance actions to be applied. 2353 */ 2354 PendingMaintenanceActions?: PendingMaintenanceActions; 2355 /** 2356 * 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. 2357 */ 2358 Marker?: String; 2359 } 2360 export interface PendingModifiedValues { 2361 /** 2362 * Contains the new DBInstanceClass for the instance that will be applied or is currently being applied. 2363 */ 2364 DBInstanceClass?: String; 2365 /** 2366 * Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied. 2367 */ 2368 AllocatedStorage?: IntegerOptional; 2369 /** 2370 * Contains the pending or currently in-progress change of the master credentials for the instance. 2371 */ 2372 MasterUserPassword?: String; 2373 /** 2374 * Specifies the pending port for the instance. 2375 */ 2376 Port?: IntegerOptional; 2377 /** 2378 * Specifies the pending number of days for which automated backups are retained. 2379 */ 2380 BackupRetentionPeriod?: IntegerOptional; 2381 /** 2382 * Indicates that the Single-AZ instance is to change to a Multi-AZ deployment. 2383 */ 2384 MultiAZ?: BooleanOptional; 2385 /** 2386 * Indicates the database engine version. 2387 */ 2388 EngineVersion?: String; 2389 /** 2390 * The license model for the instance. Valid values: license-included, bring-your-own-license, general-public-license 2391 */ 2392 LicenseModel?: String; 2393 /** 2394 * Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied. 2395 */ 2396 Iops?: IntegerOptional; 2397 /** 2398 * Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied. 2399 */ 2400 DBInstanceIdentifier?: String; 2401 /** 2402 * Specifies the storage type to be associated with the instance. 2403 */ 2404 StorageType?: String; 2405 /** 2406 * Specifies the identifier of the certificate authority (CA) certificate for the DB instance. 2407 */ 2408 CACertificateIdentifier?: String; 2409 /** 2410 * The new subnet group for the instance. 2411 */ 2412 DBSubnetGroupName?: String; 2413 /** 2414 * A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated. 2415 */ 2416 PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports; 2417 } 2418 export type ReadReplicaIdentifierList = String[]; 2419 export type ReadersArnList = String[]; 2420 export interface RebootDBInstanceMessage { 2421 /** 2422 * The instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance. 2423 */ 2424 DBInstanceIdentifier: String; 2425 /** 2426 * 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. 2427 */ 2428 ForceFailover?: BooleanOptional; 2429 } 2430 export interface RebootDBInstanceResult { 2431 DBInstance?: DBInstance; 2432 } 2433 export interface RemoveFromGlobalClusterMessage { 2434 /** 2435 * The cluster identifier to detach from the Amazon DocumentDB global cluster. 2436 */ 2437 GlobalClusterIdentifier: GlobalClusterIdentifier; 2438 /** 2439 * The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster. 2440 */ 2441 DbClusterIdentifier: String; 2442 } 2443 export interface RemoveFromGlobalClusterResult { 2444 GlobalCluster?: GlobalCluster; 2445 } 2446 export interface RemoveSourceIdentifierFromSubscriptionMessage { 2447 /** 2448 * The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from. 2449 */ 2450 SubscriptionName: String; 2451 /** 2452 * The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group. 2453 */ 2454 SourceIdentifier: String; 2455 } 2456 export interface RemoveSourceIdentifierFromSubscriptionResult { 2457 EventSubscription?: EventSubscription; 2458 } 2459 export interface RemoveTagsFromResourceMessage { 2460 /** 2461 * The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN). 2462 */ 2463 ResourceName: String; 2464 /** 2465 * The tag key (name) of the tag to be removed. 2466 */ 2467 TagKeys: KeyList; 2468 } 2469 export interface ResetDBClusterParameterGroupMessage { 2470 /** 2471 * The name of the cluster parameter group to reset. 2472 */ 2473 DBClusterParameterGroupName: String; 2474 /** 2475 * 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. 2476 */ 2477 ResetAllParameters?: Boolean; 2478 /** 2479 * 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. 2480 */ 2481 Parameters?: ParametersList; 2482 } 2483 export interface ResourcePendingMaintenanceActions { 2484 /** 2485 * The Amazon Resource Name (ARN) of the resource that has pending maintenance actions. 2486 */ 2487 ResourceIdentifier?: String; 2488 /** 2489 * A list that provides details about the pending maintenance actions for the resource. 2490 */ 2491 PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails; 2492 } 2493 export interface RestoreDBClusterFromSnapshotMessage { 2494 /** 2495 * Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in. 2496 */ 2497 AvailabilityZones?: AvailabilityZones; 2498 /** 2499 * 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 2500 */ 2501 DBClusterIdentifier: String; 2502 /** 2503 * 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. 2504 */ 2505 SnapshotIdentifier: String; 2506 /** 2507 * The database engine to use for the new cluster. Default: The same as source. Constraint: Must be compatible with the engine of the source. 2508 */ 2509 Engine: String; 2510 /** 2511 * The version of the database engine to use for the new cluster. 2512 */ 2513 EngineVersion?: String; 2514 /** 2515 * 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. 2516 */ 2517 Port?: IntegerOptional; 2518 /** 2519 * 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 2520 */ 2521 DBSubnetGroupName?: String; 2522 /** 2523 * A list of virtual private cloud (VPC) security groups that the new cluster will belong to. 2524 */ 2525 VpcSecurityGroupIds?: VpcSecurityGroupIdList; 2526 /** 2527 * The tags to be assigned to the restored cluster. 2528 */ 2529 Tags?: TagList; 2530 /** 2531 * 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. 2532 */ 2533 KmsKeyId?: String; 2534 /** 2535 * A list of log types that must be enabled for exporting to Amazon CloudWatch Logs. 2536 */ 2537 EnableCloudwatchLogsExports?: LogTypeList; 2538 /** 2539 * 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. 2540 */ 2541 DeletionProtection?: BooleanOptional; 2542 } 2543 export interface RestoreDBClusterFromSnapshotResult { 2544 DBCluster?: DBCluster; 2545 } 2546 export interface RestoreDBClusterToPointInTimeMessage { 2547 /** 2548 * 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. 2549 */ 2550 DBClusterIdentifier: String; 2551 /** 2552 * The identifier of the source cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster. 2553 */ 2554 SourceDBClusterIdentifier: String; 2555 /** 2556 * 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 2557 */ 2558 RestoreToTime?: TStamp; 2559 /** 2560 * 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. 2561 */ 2562 UseLatestRestorableTime?: Boolean; 2563 /** 2564 * 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. 2565 */ 2566 Port?: IntegerOptional; 2567 /** 2568 * The subnet group name to use for the new cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup 2569 */ 2570 DBSubnetGroupName?: String; 2571 /** 2572 * A list of VPC security groups that the new cluster belongs to. 2573 */ 2574 VpcSecurityGroupIds?: VpcSecurityGroupIdList; 2575 /** 2576 * The tags to be assigned to the restored cluster. 2577 */ 2578 Tags?: TagList; 2579 /** 2580 * 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. 2581 */ 2582 KmsKeyId?: String; 2583 /** 2584 * A list of log types that must be enabled for exporting to Amazon CloudWatch Logs. 2585 */ 2586 EnableCloudwatchLogsExports?: LogTypeList; 2587 /** 2588 * 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. 2589 */ 2590 DeletionProtection?: BooleanOptional; 2591 } 2592 export interface RestoreDBClusterToPointInTimeResult { 2593 DBCluster?: DBCluster; 2594 } 2595 export type SourceIdsList = String[]; 2596 export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string; 2597 export interface StartDBClusterMessage { 2598 /** 2599 * The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52 2600 */ 2601 DBClusterIdentifier: String; 2602 } 2603 export interface StartDBClusterResult { 2604 DBCluster?: DBCluster; 2605 } 2606 export interface StopDBClusterMessage { 2607 /** 2608 * The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52 2609 */ 2610 DBClusterIdentifier: String; 2611 } 2612 export interface StopDBClusterResult { 2613 DBCluster?: DBCluster; 2614 } 2615 export type String = string; 2616 export interface Subnet { 2617 /** 2618 * Specifies the identifier of the subnet. 2619 */ 2620 SubnetIdentifier?: String; 2621 /** 2622 * Specifies the Availability Zone for the subnet. 2623 */ 2624 SubnetAvailabilityZone?: AvailabilityZone; 2625 /** 2626 * Specifies the status of the subnet. 2627 */ 2628 SubnetStatus?: String; 2629 } 2630 export type SubnetIdentifierList = String[]; 2631 export type SubnetList = Subnet[]; 2632 export type TStamp = Date; 2633 export interface Tag { 2634 /** 2635 * 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 contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). 2636 */ 2637 Key?: String; 2638 /** 2639 * 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 contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$"). 2640 */ 2641 Value?: String; 2642 } 2643 export type TagList = Tag[]; 2644 export interface TagListMessage { 2645 /** 2646 * A list of one or more tags. 2647 */ 2648 TagList?: TagList; 2649 } 2650 export interface UpgradeTarget { 2651 /** 2652 * The name of the upgrade target database engine. 2653 */ 2654 Engine?: String; 2655 /** 2656 * The version number of the upgrade target database engine. 2657 */ 2658 EngineVersion?: String; 2659 /** 2660 * The version of the database engine that an instance can be upgraded to. 2661 */ 2662 Description?: String; 2663 /** 2664 * A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true. 2665 */ 2666 AutoUpgrade?: Boolean; 2667 /** 2668 * A value that indicates whether a database engine is upgraded to a major version. 2669 */ 2670 IsMajorVersionUpgrade?: Boolean; 2671 } 2672 export type ValidUpgradeTargetList = UpgradeTarget[]; 2673 export type VpcSecurityGroupIdList = String[]; 2674 export interface VpcSecurityGroupMembership { 2675 /** 2676 * The name of the VPC security group. 2677 */ 2678 VpcSecurityGroupId?: String; 2679 /** 2680 * The status of the VPC security group. 2681 */ 2682 Status?: String; 2683 } 2684 export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[]; 2685 /** 2686 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2687 */ 2688 export type apiVersion = "2014-10-31"|"latest"|string; 2689 export interface ClientApiVersions { 2690 /** 2691 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2692 */ 2693 apiVersion?: apiVersion; 2694 } 2695 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 2696 /** 2697 * Contains interfaces for use with the DocDB client. 2698 */ 2699 export import Types = DocDB; 2700 } 2701 export = DocDB;