💾 Archived View for gmi.noulin.net › gitRepositories › git-off › file › src › node_modules › aws-sdk… captured on 2023-01-29 at 11:53:35. Gemini links have been rewritten to link to archived content
-=-=-=-=-=-=-
rds.d.ts (320060B)
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 {ServiceConfigurationOptions} from '../lib/service';
6 import {ConfigBase as Config} from '../lib/config';
7 interface Blob {}
8 declare class RDS extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: RDS.Types.ClientConfiguration)
13 config: Config & RDS.Types.ClientConfiguration;
14 /**
15 * Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
16 */
17 addRoleToDBCluster(params: RDS.Types.AddRoleToDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
18 /**
19 * Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
20 */
21 addRoleToDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
22 /**
23 * Adds a source identifier to an existing RDS event notification subscription.
24 */
25 addSourceIdentifierToSubscription(params: RDS.Types.AddSourceIdentifierToSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<RDS.Types.AddSourceIdentifierToSubscriptionResult, AWSError>;
26 /**
27 * Adds a source identifier to an existing RDS event notification subscription.
28 */
29 addSourceIdentifierToSubscription(callback?: (err: AWSError, data: RDS.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<RDS.Types.AddSourceIdentifierToSubscriptionResult, AWSError>;
30 /**
31 * Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
32 */
33 addTagsToResource(params: RDS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
34 /**
35 * Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
36 */
37 addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
38 /**
39 * Applies a pending maintenance action to a resource (for example, to a DB instance).
40 */
41 applyPendingMaintenanceAction(params: RDS.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request<RDS.Types.ApplyPendingMaintenanceActionResult, AWSError>;
42 /**
43 * Applies a pending maintenance action to a resource (for example, to a DB instance).
44 */
45 applyPendingMaintenanceAction(callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request<RDS.Types.ApplyPendingMaintenanceActionResult, AWSError>;
46 /**
47 * Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
48 */
49 authorizeDBSecurityGroupIngress(params: RDS.Types.AuthorizeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
50 /**
51 * Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
52 */
53 authorizeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
54 /**
55 * Copies the specified DB cluster parameter group.
56 */
57 copyDBClusterParameterGroup(params: RDS.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
58 /**
59 * Copies the specified DB cluster parameter group.
60 */
61 copyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
62 /**
63 * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
64 */
65 copyDBClusterSnapshot(params: RDS.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
66 /**
67 * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
68 */
69 copyDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
70 /**
71 * Copies the specified DB parameter group.
72 */
73 copyDBParameterGroup(params: RDS.Types.CopyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
74 /**
75 * Copies the specified DB parameter group.
76 */
77 copyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
78 /**
79 * Copies the specified DB snapshot. The source DB snapshot must be in the "available" state. If you are copying from a shared manual DB snapshot, the SourceDBSnapshotIdentifier must be the ARN of the shared DB snapshot.
80 */
81 copyDBSnapshot(params: RDS.Types.CopyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
82 /**
83 * Copies the specified DB snapshot. The source DB snapshot must be in the "available" state. If you are copying from a shared manual DB snapshot, the SourceDBSnapshotIdentifier must be the ARN of the shared DB snapshot.
84 */
85 copyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
86 /**
87 * Copies the specified option group.
88 */
89 copyOptionGroup(params: RDS.Types.CopyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request<RDS.Types.CopyOptionGroupResult, AWSError>;
90 /**
91 * Copies the specified option group.
92 */
93 copyOptionGroup(callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request<RDS.Types.CopyOptionGroupResult, AWSError>;
94 /**
95 * Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
96 */
97 createDBCluster(params: RDS.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
98 /**
99 * Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
100 */
101 createDBCluster(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
102 /**
103 * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
104 */
105 createDBClusterParameterGroup(params: RDS.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
106 /**
107 * Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
108 */
109 createDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
110 /**
111 * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
112 */
113 createDBClusterSnapshot(params: RDS.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
114 /**
115 * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
116 */
117 createDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
118 /**
119 * Creates a new DB instance.
120 */
121 createDBInstance(params: RDS.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
122 /**
123 * Creates a new DB instance.
124 */
125 createDBInstance(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
126 /**
127 * Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance. All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below. The source DB instance must have backup retention enabled.
128 */
129 createDBInstanceReadReplica(params: RDS.Types.CreateDBInstanceReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
130 /**
131 * Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance. All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below. The source DB instance must have backup retention enabled.
132 */
133 createDBInstanceReadReplica(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
134 /**
135 * Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
136 */
137 createDBParameterGroup(params: RDS.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
138 /**
139 * Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
140 */
141 createDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
142 /**
143 * Creates a new DB security group. DB security groups control access to a DB instance.
144 */
145 createDBSecurityGroup(params: RDS.Types.CreateDBSecurityGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
146 /**
147 * Creates a new DB security group. DB security groups control access to a DB instance.
148 */
149 createDBSecurityGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
150 /**
151 * Creates a DBSnapshot. The source DBInstance must be in "available" state.
152 */
153 createDBSnapshot(params: RDS.Types.CreateDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
154 /**
155 * Creates a DBSnapshot. The source DBInstance must be in "available" state.
156 */
157 createDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
158 /**
159 * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
160 */
161 createDBSubnetGroup(params: RDS.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
162 /**
163 * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
164 */
165 createDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
166 /**
167 * Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events 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 will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
168 */
169 createEventSubscription(params: RDS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
170 /**
171 * Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events 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 will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
172 */
173 createEventSubscription(callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
174 /**
175 * Creates a new option group. You can create up to 20 option groups.
176 */
177 createOptionGroup(params: RDS.Types.CreateOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
178 /**
179 * Creates a new option group. You can create up to 20 option groups.
180 */
181 createOptionGroup(callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
182 /**
183 * The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
184 */
185 deleteDBCluster(params: RDS.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
186 /**
187 * The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
188 */
189 deleteDBCluster(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
190 /**
191 * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
192 */
193 deleteDBClusterParameterGroup(params: RDS.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
194 /**
195 * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
196 */
197 deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
198 /**
199 * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
200 */
201 deleteDBClusterSnapshot(params: RDS.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
202 /**
203 * Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
204 */
205 deleteDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
206 /**
207 * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true. If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if the following are true: The DB cluster is a Read Replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
208 */
209 deleteDBInstance(params: RDS.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
210 /**
211 * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true. If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if the following are true: The DB cluster is a Read Replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
212 */
213 deleteDBInstance(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
214 /**
215 * Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
216 */
217 deleteDBParameterGroup(params: RDS.Types.DeleteDBParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
218 /**
219 * Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
220 */
221 deleteDBParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
222 /**
223 * Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
224 */
225 deleteDBSecurityGroup(params: RDS.Types.DeleteDBSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
226 /**
227 * Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
228 */
229 deleteDBSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
230 /**
231 * Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated. The DBSnapshot must be in the available state to be deleted.
232 */
233 deleteDBSnapshot(params: RDS.Types.DeleteDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request<RDS.Types.DeleteDBSnapshotResult, AWSError>;
234 /**
235 * Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated. The DBSnapshot must be in the available state to be deleted.
236 */
237 deleteDBSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request<RDS.Types.DeleteDBSnapshotResult, AWSError>;
238 /**
239 * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
240 */
241 deleteDBSubnetGroup(params: RDS.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
242 /**
243 * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
244 */
245 deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
246 /**
247 * Deletes an RDS event notification subscription.
248 */
249 deleteEventSubscription(params: RDS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request<RDS.Types.DeleteEventSubscriptionResult, AWSError>;
250 /**
251 * Deletes an RDS event notification subscription.
252 */
253 deleteEventSubscription(callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request<RDS.Types.DeleteEventSubscriptionResult, AWSError>;
254 /**
255 * Deletes an existing option group.
256 */
257 deleteOptionGroup(params: RDS.Types.DeleteOptionGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
258 /**
259 * Deletes an existing option group.
260 */
261 deleteOptionGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
262 /**
263 * Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command does not take any parameters.
264 */
265 describeAccountAttributes(params: RDS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request<RDS.Types.AccountAttributesMessage, AWSError>;
266 /**
267 * Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command does not take any parameters.
268 */
269 describeAccountAttributes(callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request<RDS.Types.AccountAttributesMessage, AWSError>;
270 /**
271 * Lists the set of CA certificates provided by Amazon RDS for this AWS account.
272 */
273 describeCertificates(params: RDS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request<RDS.Types.CertificateMessage, AWSError>;
274 /**
275 * Lists the set of CA certificates provided by Amazon RDS for this AWS account.
276 */
277 describeCertificates(callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request<RDS.Types.CertificateMessage, AWSError>;
278 /**
279 * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
280 */
281 describeDBClusterParameterGroups(params: RDS.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
282 /**
283 * Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
284 */
285 describeDBClusterParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
286 /**
287 * Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
288 */
289 describeDBClusterParameters(params: RDS.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
290 /**
291 * Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
292 */
293 describeDBClusterParameters(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
294 /**
295 * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
296 */
297 describeDBClusterSnapshotAttributes(params: RDS.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
298 /**
299 * Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
300 */
301 describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
302 /**
303 * Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
304 */
305 describeDBClusterSnapshots(params: RDS.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
306 /**
307 * Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
308 */
309 describeDBClusterSnapshots(callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
310 /**
311 * Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
312 */
313 describeDBClusters(params: RDS.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
314 /**
315 * Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
316 */
317 describeDBClusters(callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
318 /**
319 * Returns a list of the available DB engines.
320 */
321 describeDBEngineVersions(params: RDS.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request<RDS.Types.DBEngineVersionMessage, AWSError>;
322 /**
323 * Returns a list of the available DB engines.
324 */
325 describeDBEngineVersions(callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request<RDS.Types.DBEngineVersionMessage, AWSError>;
326 /**
327 * Returns information about provisioned RDS instances. This API supports pagination.
328 */
329 describeDBInstances(params: RDS.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
330 /**
331 * Returns information about provisioned RDS instances. This API supports pagination.
332 */
333 describeDBInstances(callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
334 /**
335 * Returns a list of DB log files for the DB instance.
336 */
337 describeDBLogFiles(params: RDS.Types.DescribeDBLogFilesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
338 /**
339 * Returns a list of DB log files for the DB instance.
340 */
341 describeDBLogFiles(callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
342 /**
343 * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
344 */
345 describeDBParameterGroups(params: RDS.Types.DescribeDBParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request<RDS.Types.DBParameterGroupsMessage, AWSError>;
346 /**
347 * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
348 */
349 describeDBParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request<RDS.Types.DBParameterGroupsMessage, AWSError>;
350 /**
351 * Returns the detailed parameter list for a particular DB parameter group.
352 */
353 describeDBParameters(params: RDS.Types.DescribeDBParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request<RDS.Types.DBParameterGroupDetails, AWSError>;
354 /**
355 * Returns the detailed parameter list for a particular DB parameter group.
356 */
357 describeDBParameters(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request<RDS.Types.DBParameterGroupDetails, AWSError>;
358 /**
359 * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
360 */
361 describeDBSecurityGroups(params: RDS.Types.DescribeDBSecurityGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request<RDS.Types.DBSecurityGroupMessage, AWSError>;
362 /**
363 * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
364 */
365 describeDBSecurityGroups(callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request<RDS.Types.DBSecurityGroupMessage, AWSError>;
366 /**
367 * Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
368 */
369 describeDBSnapshotAttributes(params: RDS.Types.DescribeDBSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBSnapshotAttributesResult, AWSError>;
370 /**
371 * Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
372 */
373 describeDBSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBSnapshotAttributesResult, AWSError>;
374 /**
375 * Returns information about DB snapshots. This API action supports pagination.
376 */
377 describeDBSnapshots(params: RDS.Types.DescribeDBSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
378 /**
379 * Returns information about DB snapshots. This API action supports pagination.
380 */
381 describeDBSnapshots(callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
382 /**
383 * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
384 */
385 describeDBSubnetGroups(params: RDS.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
386 /**
387 * Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
388 */
389 describeDBSubnetGroups(callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
390 /**
391 * Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
392 */
393 describeEngineDefaultClusterParameters(params: RDS.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
394 /**
395 * Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
396 */
397 describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
398 /**
399 * Returns the default engine and system parameter information for the specified database engine.
400 */
401 describeEngineDefaultParameters(params: RDS.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultParametersResult, AWSError>;
402 /**
403 * Returns the default engine and system parameter information for the specified database engine.
404 */
405 describeEngineDefaultParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultParametersResult, AWSError>;
406 /**
407 * Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
408 */
409 describeEventCategories(params: RDS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request<RDS.Types.EventCategoriesMessage, AWSError>;
410 /**
411 * Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
412 */
413 describeEventCategories(callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request<RDS.Types.EventCategoriesMessage, AWSError>;
414 /**
415 * 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.
416 */
417 describeEventSubscriptions(params: RDS.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
418 /**
419 * 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.
420 */
421 describeEventSubscriptions(callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
422 /**
423 * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
424 */
425 describeEvents(params: RDS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
426 /**
427 * Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
428 */
429 describeEvents(callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
430 /**
431 * Describes all available options.
432 */
433 describeOptionGroupOptions(params: RDS.Types.DescribeOptionGroupOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request<RDS.Types.OptionGroupOptionsMessage, AWSError>;
434 /**
435 * Describes all available options.
436 */
437 describeOptionGroupOptions(callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request<RDS.Types.OptionGroupOptionsMessage, AWSError>;
438 /**
439 * Describes the available option groups.
440 */
441 describeOptionGroups(params: RDS.Types.DescribeOptionGroupsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
442 /**
443 * Describes the available option groups.
444 */
445 describeOptionGroups(callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
446 /**
447 * Returns a list of orderable DB instance options for the specified engine.
448 */
449 describeOrderableDBInstanceOptions(params: RDS.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
450 /**
451 * Returns a list of orderable DB instance options for the specified engine.
452 */
453 describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
454 /**
455 * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
456 */
457 describePendingMaintenanceActions(params: RDS.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request<RDS.Types.PendingMaintenanceActionsMessage, AWSError>;
458 /**
459 * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
460 */
461 describePendingMaintenanceActions(callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request<RDS.Types.PendingMaintenanceActionsMessage, AWSError>;
462 /**
463 * Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
464 */
465 describeReservedDBInstances(params: RDS.Types.DescribeReservedDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request<RDS.Types.ReservedDBInstanceMessage, AWSError>;
466 /**
467 * Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
468 */
469 describeReservedDBInstances(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request<RDS.Types.ReservedDBInstanceMessage, AWSError>;
470 /**
471 * Lists available reserved DB instance offerings.
472 */
473 describeReservedDBInstancesOfferings(params: RDS.Types.DescribeReservedDBInstancesOfferingsMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request<RDS.Types.ReservedDBInstancesOfferingMessage, AWSError>;
474 /**
475 * Lists available reserved DB instance offerings.
476 */
477 describeReservedDBInstancesOfferings(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request<RDS.Types.ReservedDBInstancesOfferingMessage, AWSError>;
478 /**
479 * Returns a list of the source AWS regions where the current AWS region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
480 */
481 describeSourceRegions(params: RDS.Types.DescribeSourceRegionsMessage, callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
482 /**
483 * Returns a list of the source AWS regions where the current AWS region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
484 */
485 describeSourceRegions(callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
486 /**
487 * Downloads all or a portion of the specified log file, up to 1 MB in size.
488 */
489 downloadDBLogFilePortion(params: RDS.Types.DownloadDBLogFilePortionMessage, callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
490 /**
491 * Downloads all or a portion of the specified log file, up to 1 MB in size.
492 */
493 downloadDBLogFilePortion(callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
494 /**
495 * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance. Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
496 */
497 failoverDBCluster(params: RDS.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
498 /**
499 * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance. Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
500 */
501 failoverDBCluster(callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
502 /**
503 * Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
504 */
505 listTagsForResource(params: RDS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request<RDS.Types.TagListMessage, AWSError>;
506 /**
507 * Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
508 */
509 listTagsForResource(callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request<RDS.Types.TagListMessage, AWSError>;
510 /**
511 * Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
512 */
513 modifyDBCluster(params: RDS.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
514 /**
515 * Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
516 */
517 modifyDBCluster(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
518 /**
519 * Modifies the parameters of a DB 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. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
520 */
521 modifyDBClusterParameterGroup(params: RDS.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
522 /**
523 * Modifies the parameters of a DB 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. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
524 */
525 modifyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
526 /**
527 * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action. If a manual DB cluster snapshot is encrypted, it cannot be shared.
528 */
529 modifyDBClusterSnapshotAttribute(params: RDS.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
530 /**
531 * Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action. If a manual DB cluster snapshot is encrypted, it cannot be shared.
532 */
533 modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
534 /**
535 * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
536 */
537 modifyDBInstance(params: RDS.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request<RDS.Types.ModifyDBInstanceResult, AWSError>;
538 /**
539 * Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
540 */
541 modifyDBInstance(callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request<RDS.Types.ModifyDBInstanceResult, AWSError>;
542 /**
543 * Modifies the parameters of a DB 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 without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
544 */
545 modifyDBParameterGroup(params: RDS.Types.ModifyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
546 /**
547 * Modifies the parameters of a DB 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 without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
548 */
549 modifyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
550 /**
551 * Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. If the manual DB snapshot is encrypted, it cannot be shared.
552 */
553 modifyDBSnapshotAttribute(params: RDS.Types.ModifyDBSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
554 /**
555 * Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. If the manual DB snapshot is encrypted, it cannot be shared.
556 */
557 modifyDBSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
558 /**
559 * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
560 */
561 modifyDBSubnetGroup(params: RDS.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request<RDS.Types.ModifyDBSubnetGroupResult, AWSError>;
562 /**
563 * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
564 */
565 modifyDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request<RDS.Types.ModifyDBSubnetGroupResult, AWSError>;
566 /**
567 * Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
568 */
569 modifyEventSubscription(params: RDS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
570 /**
571 * Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
572 */
573 modifyEventSubscription(callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
574 /**
575 * Modifies an existing option group.
576 */
577 modifyOptionGroup(params: RDS.Types.ModifyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
578 /**
579 * Modifies an existing option group.
580 */
581 modifyOptionGroup(callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
582 /**
583 * Promotes a Read Replica DB instance to a standalone DB instance. We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
584 */
585 promoteReadReplica(params: RDS.Types.PromoteReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
586 /**
587 * Promotes a Read Replica DB instance to a standalone DB instance. We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
588 */
589 promoteReadReplica(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
590 /**
591 * Promotes a Read Replica DB cluster to a standalone DB cluster.
592 */
593 promoteReadReplicaDBCluster(params: RDS.Types.PromoteReadReplicaDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
594 /**
595 * Promotes a Read Replica DB cluster to a standalone DB cluster.
596 */
597 promoteReadReplicaDBCluster(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
598 /**
599 * Purchases a reserved DB instance offering.
600 */
601 purchaseReservedDBInstancesOffering(params: RDS.Types.PurchaseReservedDBInstancesOfferingMessage, callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
602 /**
603 * Purchases a reserved DB instance offering.
604 */
605 purchaseReservedDBInstancesOffering(callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
606 /**
607 * Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed. If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs. The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
608 */
609 rebootDBInstance(params: RDS.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
610 /**
611 * Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed. If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs. The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
612 */
613 rebootDBInstance(callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
614 /**
615 * Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
616 */
617 removeRoleFromDBCluster(params: RDS.Types.RemoveRoleFromDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
618 /**
619 * Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
620 */
621 removeRoleFromDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
622 /**
623 * Removes a source identifier from an existing RDS event notification subscription.
624 */
625 removeSourceIdentifierFromSubscription(params: RDS.Types.RemoveSourceIdentifierFromSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<RDS.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
626 /**
627 * Removes a source identifier from an existing RDS event notification subscription.
628 */
629 removeSourceIdentifierFromSubscription(callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<RDS.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
630 /**
631 * Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
632 */
633 removeTagsFromResource(params: RDS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
634 /**
635 * Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.
636 */
637 removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
638 /**
639 * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
640 */
641 resetDBClusterParameterGroup(params: RDS.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
642 /**
643 * Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
644 */
645 resetDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
646 /**
647 * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
648 */
649 resetDBParameterGroup(params: RDS.Types.ResetDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
650 /**
651 * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
652 */
653 resetDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
654 /**
655 * Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket.
656 */
657 restoreDBClusterFromS3(params: RDS.Types.RestoreDBClusterFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
658 /**
659 * Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket.
660 */
661 restoreDBClusterFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
662 /**
663 * Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
664 */
665 restoreDBClusterFromSnapshot(params: RDS.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
666 /**
667 * Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
668 */
669 restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
670 /**
671 * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
672 */
673 restoreDBClusterToPointInTime(params: RDS.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
674 /**
675 * Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
676 */
677 restoreDBClusterToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
678 /**
679 * Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
680 */
681 restoreDBInstanceFromDBSnapshot(params: RDS.Types.RestoreDBInstanceFromDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
682 /**
683 * Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
684 */
685 restoreDBInstanceFromDBSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
686 /**
687 * Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
688 */
689 restoreDBInstanceToPointInTime(params: RDS.Types.RestoreDBInstanceToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request<RDS.Types.RestoreDBInstanceToPointInTimeResult, AWSError>;
690 /**
691 * Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
692 */
693 restoreDBInstanceToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request<RDS.Types.RestoreDBInstanceToPointInTimeResult, AWSError>;
694 /**
695 * Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
696 */
697 revokeDBSecurityGroupIngress(params: RDS.Types.RevokeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request<RDS.Types.RevokeDBSecurityGroupIngressResult, AWSError>;
698 /**
699 * Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
700 */
701 revokeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request<RDS.Types.RevokeDBSecurityGroupIngressResult, AWSError>;
702 /**
703 * Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
704 */
705 waitFor(state: "dBInstanceAvailable", params: RDS.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
706 /**
707 * Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
708 */
709 waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
710 /**
711 * Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
712 */
713 waitFor(state: "dBInstanceDeleted", params: RDS.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
714 /**
715 * Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
716 */
717 waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
718 }
719 declare namespace RDS.Types {
720 export interface AccountAttributesMessage {
721 /**
722 * A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
723 */
724 AccountQuotas?: AccountQuotaList;
725 }
726 export interface AccountQuota {
727 /**
728 * The name of the Amazon RDS quota for this AWS account.
729 */
730 AccountQuotaName?: String;
731 /**
732 * The amount currently used toward the quota maximum.
733 */
734 Used?: Long;
735 /**
736 * The maximum allowed value for the quota.
737 */
738 Max?: Long;
739 }
740 export type AccountQuotaList = AccountQuota[];
741 export interface AddRoleToDBClusterMessage {
742 /**
743 * The name of the DB cluster to associate the IAM role with.
744 */
745 DBClusterIdentifier: String;
746 /**
747 * The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
748 */
749 RoleArn: String;
750 }
751 export interface AddSourceIdentifierToSubscriptionMessage {
752 /**
753 * The name of the RDS event notification subscription you want to add a source identifier to.
754 */
755 SubscriptionName: String;
756 /**
757 * The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. Constraints: If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
758 */
759 SourceIdentifier: String;
760 }
761 export interface AddSourceIdentifierToSubscriptionResult {
762 EventSubscription?: EventSubscription;
763 }
764 export interface AddTagsToResourceMessage {
765 /**
766 * The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
767 */
768 ResourceName: String;
769 /**
770 * The tags to be assigned to the Amazon RDS resource.
771 */
772 Tags: TagList;
773 }
774 export type ApplyMethod = "immediate"|"pending-reboot"|string;
775 export interface ApplyPendingMaintenanceActionMessage {
776 /**
777 * The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
778 */
779 ResourceIdentifier: String;
780 /**
781 * The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade
782 */
783 ApplyAction: String;
784 /**
785 * A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate cannot 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.
786 */
787 OptInType: String;
788 }
789 export interface ApplyPendingMaintenanceActionResult {
790 ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions;
791 }
792 export type AttributeValueList = String[];
793 export interface AuthorizeDBSecurityGroupIngressMessage {
794 /**
795 * The name of the DB security group to add authorization to.
796 */
797 DBSecurityGroupName: String;
798 /**
799 * The IP range to authorize.
800 */
801 CIDRIP?: String;
802 /**
803 * Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
804 */
805 EC2SecurityGroupName?: String;
806 /**
807 * Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
808 */
809 EC2SecurityGroupId?: String;
810 /**
811 * AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
812 */
813 EC2SecurityGroupOwnerId?: String;
814 }
815 export interface AuthorizeDBSecurityGroupIngressResult {
816 DBSecurityGroup?: DBSecurityGroup;
817 }
818 export interface AvailabilityZone {
819 /**
820 * The name of the availability zone.
821 */
822 Name?: String;
823 }
824 export type AvailabilityZoneList = AvailabilityZone[];
825 export type AvailabilityZones = String[];
826 export type Boolean = boolean;
827 export type BooleanOptional = boolean;
828 export interface Certificate {
829 /**
830 * The unique key that identifies a certificate.
831 */
832 CertificateIdentifier?: String;
833 /**
834 * The type of the certificate.
835 */
836 CertificateType?: String;
837 /**
838 * The thumbprint of the certificate.
839 */
840 Thumbprint?: String;
841 /**
842 * The starting date from which the certificate is valid.
843 */
844 ValidFrom?: TStamp;
845 /**
846 * The final date that the certificate continues to be valid.
847 */
848 ValidTill?: TStamp;
849 /**
850 * The Amazon Resource Name (ARN) for the certificate.
851 */
852 CertificateArn?: String;
853 }
854 export type CertificateList = Certificate[];
855 export interface CertificateMessage {
856 /**
857 * The list of Certificate objects for the AWS account.
858 */
859 Certificates?: CertificateList;
860 /**
861 * 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 .
862 */
863 Marker?: String;
864 }
865 export interface CharacterSet {
866 /**
867 * The name of the character set.
868 */
869 CharacterSetName?: String;
870 /**
871 * The description of the character set.
872 */
873 CharacterSetDescription?: String;
874 }
875 export interface CopyDBClusterParameterGroupMessage {
876 /**
877 * The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN). Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a different region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
878 */
879 SourceDBClusterParameterGroupIdentifier: String;
880 /**
881 * The identifier for the copied DB cluster parameter group. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-cluster-param-group1
882 */
883 TargetDBClusterParameterGroupIdentifier: String;
884 /**
885 * A description for the copied DB cluster parameter group.
886 */
887 TargetDBClusterParameterGroupDescription: String;
888 Tags?: TagList;
889 }
890 export interface CopyDBClusterParameterGroupResult {
891 DBClusterParameterGroup?: DBClusterParameterGroup;
892 }
893 export interface CopyDBClusterSnapshotMessage {
894 /**
895 * The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot1
896 */
897 SourceDBClusterSnapshotIdentifier: String;
898 /**
899 * The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2
900 */
901 TargetDBClusterSnapshotIdentifier: String;
902 Tags?: TagList;
903 }
904 export interface CopyDBClusterSnapshotResult {
905 DBClusterSnapshot?: DBClusterSnapshot;
906 }
907 export interface CopyDBParameterGroupMessage {
908 /**
909 * The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN). Constraints: Must specify a valid DB parameter group. Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
910 */
911 SourceDBParameterGroupIdentifier: String;
912 /**
913 * The identifier for the copied DB parameter group. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-db-parameter-group
914 */
915 TargetDBParameterGroupIdentifier: String;
916 /**
917 * A description for the copied DB parameter group.
918 */
919 TargetDBParameterGroupDescription: String;
920 Tags?: TagList;
921 }
922 export interface CopyDBParameterGroupResult {
923 DBParameterGroup?: DBParameterGroup;
924 }
925 export interface CopyDBSnapshotMessage {
926 /**
927 * The identifier for the source DB snapshot. If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot. 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 DB snapshot identifier. If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot. Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
928 */
929 SourceDBSnapshotIdentifier: String;
930 /**
931 * The identifier for the copied snapshot. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot
932 */
933 TargetDBSnapshotIdentifier: String;
934 /**
935 * The AWS Key Management Service (AWS KMS) key identifier for an encrypted DB snapshot. The KMS key identifier is the Amazon Resource Name (ARN) or the KMS key alias for the KMS encryption key. If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key. If you copy an encrypted DB snapshot from your AWS 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 DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.
936 */
937 KmsKeyId?: String;
938 Tags?: TagList;
939 /**
940 * True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.
941 */
942 CopyTags?: BooleanOptional;
943 }
944 export interface CopyDBSnapshotResult {
945 DBSnapshot?: DBSnapshot;
946 }
947 export interface CopyOptionGroupMessage {
948 /**
949 * The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN). Constraints: Must specify a valid option group. If the source option group is in the same region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN. If the source option group is in a different region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.
950 */
951 SourceOptionGroupIdentifier: String;
952 /**
953 * The identifier for the copied option group. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-option-group
954 */
955 TargetOptionGroupIdentifier: String;
956 /**
957 * The description for the copied option group.
958 */
959 TargetOptionGroupDescription: String;
960 Tags?: TagList;
961 }
962 export interface CopyOptionGroupResult {
963 OptionGroup?: OptionGroup;
964 }
965 export interface CreateDBClusterMessage {
966 /**
967 * A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.
968 */
969 AvailabilityZones?: AvailabilityZones;
970 /**
971 * 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
972 */
973 BackupRetentionPeriod?: IntegerOptional;
974 /**
975 * A value that indicates that the DB cluster should be associated with the specified CharacterSet.
976 */
977 CharacterSetName?: String;
978 /**
979 * The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
980 */
981 DatabaseName?: String;
982 /**
983 * The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
984 */
985 DBClusterIdentifier: String;
986 /**
987 * The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
988 */
989 DBClusterParameterGroupName?: String;
990 /**
991 * A list of EC2 VPC security groups to associate with this DB cluster.
992 */
993 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
994 /**
995 * A DB subnet group to associate with this DB cluster. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
996 */
997 DBSubnetGroupName?: String;
998 /**
999 * The name of the database engine to be used for this DB cluster. Valid Values: aurora
1000 */
1001 Engine: String;
1002 /**
1003 * The version number of the database engine to use. Aurora Example: 5.6.10a
1004 */
1005 EngineVersion?: String;
1006 /**
1007 * The port number on which the instances in the DB cluster accept connections. Default: 3306
1008 */
1009 Port?: IntegerOptional;
1010 /**
1011 * The name of the master user for the DB cluster. Constraints: Must be 1 to 16 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine.
1012 */
1013 MasterUsername?: String;
1014 /**
1015 * The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
1016 */
1017 MasterUserPassword?: String;
1018 /**
1019 * A value that indicates that the DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
1020 */
1021 OptionGroupName?: String;
1022 /**
1023 * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Times should be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
1024 */
1025 PreferredBackupWindow?: String;
1026 /**
1027 * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
1028 */
1029 PreferredMaintenanceWindow?: String;
1030 /**
1031 * The Amazon Resource Name (ARN) of the source DB cluster if this DB cluster is created as a Read Replica.
1032 */
1033 ReplicationSourceIdentifier?: String;
1034 Tags?: TagList;
1035 /**
1036 * Specifies whether the DB cluster is encrypted.
1037 */
1038 StorageEncrypted?: BooleanOptional;
1039 /**
1040 * The KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
1041 */
1042 KmsKeyId?: String;
1043 }
1044 export interface CreateDBClusterParameterGroupMessage {
1045 /**
1046 * The name of the DB cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
1047 */
1048 DBClusterParameterGroupName: String;
1049 /**
1050 * The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
1051 */
1052 DBParameterGroupFamily: String;
1053 /**
1054 * The description for the DB cluster parameter group.
1055 */
1056 Description: String;
1057 Tags?: TagList;
1058 }
1059 export interface CreateDBClusterParameterGroupResult {
1060 DBClusterParameterGroup?: DBClusterParameterGroup;
1061 }
1062 export interface CreateDBClusterResult {
1063 DBCluster?: DBCluster;
1064 }
1065 export interface CreateDBClusterSnapshotMessage {
1066 /**
1067 * The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1
1068 */
1069 DBClusterSnapshotIdentifier: String;
1070 /**
1071 * The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
1072 */
1073 DBClusterIdentifier: String;
1074 /**
1075 * The tags to be assigned to the DB cluster snapshot.
1076 */
1077 Tags?: TagList;
1078 }
1079 export interface CreateDBClusterSnapshotResult {
1080 DBClusterSnapshot?: DBClusterSnapshot;
1081 }
1082 export interface CreateDBInstanceMessage {
1083 /**
1084 * The meaning of this parameter differs according to the database engine you use. Type: String MySQL The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 alphanumeric characters Cannot be a word reserved by the specified database engine MariaDB The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 alphanumeric characters Cannot be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance. Constraints: Must contain 1 to 63 alphanumeric characters Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9). Cannot be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. Default: ORCL Constraints: Cannot be longer than 8 characters SQL Server Not applicable. Must be null. Amazon Aurora The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 alphanumeric characters Cannot be a word reserved by the specified database engine
1085 */
1086 DBName?: String;
1087 /**
1088 * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server). First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
1089 */
1090 DBInstanceIdentifier: String;
1091 /**
1092 * The amount of storage (in gigabytes) to be initially allocated for the database instance. Type: Integer MySQL Constraints: Must be an integer from 5 to 6144. MariaDB Constraints: Must be an integer from 5 to 6144. PostgreSQL Constraints: Must be an integer from 5 to 6144. Oracle Constraints: Must be an integer from 10 to 6144. SQL Server Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
1093 */
1094 AllocatedStorage?: IntegerOptional;
1095 /**
1096 * The compute and memory capacity of the DB instance. Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
1097 */
1098 DBInstanceClass: String;
1099 /**
1100 * The name of the database engine to be used for this instance. Valid Values: mysql | mariadb | oracle-se1 | oracle-se2 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora Not every database engine is available for every AWS region.
1101 */
1102 Engine: String;
1103 /**
1104 * The name of master user for the client DB instance. MySQL Constraints: Must be 1 to 16 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine. MariaDB Constraints: Must be 1 to 16 alphanumeric characters. Cannot be a reserved word for the chosen database engine. Type: String Oracle Constraints: Must be 1 to 30 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine. SQL Server Constraints: Must be 1 to 128 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine. PostgreSQL Constraints: Must be 1 to 63 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine.
1105 */
1106 MasterUsername?: String;
1107 /**
1108 * The password for the master database user. Can be any printable ASCII character except "/", """, or "@". Type: String MySQL Constraints: Must contain from 8 to 41 characters. MariaDB Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. SQL Server Constraints: Must contain from 8 to 128 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. Amazon Aurora Constraints: Must contain from 8 to 41 characters.
1109 */
1110 MasterUserPassword?: String;
1111 /**
1112 * A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
1113 */
1114 DBSecurityGroups?: DBSecurityGroupNameList;
1115 /**
1116 * A list of EC2 VPC security groups to associate with this DB instance. Default: The default EC2 VPC security group for the DB subnet group's VPC.
1117 */
1118 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1119 /**
1120 * The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones. Default: A random, system-chosen Availability Zone in the endpoint's region. Example: us-east-1d Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.
1121 */
1122 AvailabilityZone?: String;
1123 /**
1124 * A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance.
1125 */
1126 DBSubnetGroupName?: String;
1127 /**
1128 * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
1129 */
1130 PreferredMaintenanceWindow?: String;
1131 /**
1132 * The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
1133 */
1134 DBParameterGroupName?: String;
1135 /**
1136 * The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: Must be a value from 0 to 35 Cannot be set to 0 if the DB instance is a source to Read Replicas
1137 */
1138 BackupRetentionPeriod?: IntegerOptional;
1139 /**
1140 * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Times should be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
1141 */
1142 PreferredBackupWindow?: String;
1143 /**
1144 * The port number on which the database accepts connections. MySQL Default: 3306 Valid Values: 1150-65535 Type: Integer MariaDB Default: 3306 Valid Values: 1150-65535 Type: Integer PostgreSQL Default: 5432 Valid Values: 1150-65535 Type: Integer Oracle Default: 1521 Valid Values: 1150-65535 SQL Server Default: 1433 Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156. Amazon Aurora Default: 3306 Valid Values: 1150-65535 Type: Integer
1145 */
1146 Port?: IntegerOptional;
1147 /**
1148 * Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
1149 */
1150 MultiAZ?: BooleanOptional;
1151 /**
1152 * The version number of the database engine to use. The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region. Amazon Aurora Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-2, eu-west-1, us-east-1, us-west-2): 5.6.10a MariaDB Version 10.1 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 10.1.14 Version 10.0 (available in all AWS regions): 10.0.17 | 10.0.24 MySQL Version 5.7 (available in all AWS regions): 5.7.10 | 5.7.11 Version 5.6 (available in all AWS regions): 5.6.27 | 5.6.29 Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.23 Version 5.6 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 Version 5.5 (available in all AWS regions): 5.5.46 Version 5.5 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.5.42 Version 5.5 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.5.40b | 5.5.41 Version 5.5 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.5.40 | 5.5.40a Oracle Database Enterprise Edition (oracle-ee) Version 12.1.0.2 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.2.v5 Version 12.1.0.2 (available in all AWS regions): 12.1.0.2.v1 | 12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4 Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v6 Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5 Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-gov-west-1, us-west-1, us-west-2): 12.1.0.1.v1 | 12.1.0.1.v2 Version 11.2.0.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.4.v6 | 11.2.0.4.v9 Version 11.2.0.4 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4 | 11.2.0.4.v5 | 11.2.0.4.v7 | 11.2.0.4.v8 Oracle Database Standard Edition Two (oracle-se2) Version 12.1.0.2 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.2.v5 Version 12.1.0.2 (available in all AWS regions): 12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4 Oracle Database Standard Edition One (oracle-se1) Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v6 Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5 Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-gov-west-1, us-west-1, us-west-2): 12.1.0.1.v1 | 12.1.0.1.v2 Version 11.2.0.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.4.v6 | 11.2.0.4.v9 Version 11.2.0.4 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4 | 11.2.0.4.v5 | 11.2.0.4.v7 | 11.2.0.4.v8 Oracle Database Standard Edition (oracle-se) Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v6 Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5 Version 12.1.0.1 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-gov-west-1, us-west-1, us-west-2): 12.1.0.1.v1 | 12.1.0.1.v2 Version 11.2.0.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.4.v6 | 11.2.0.4.v9 Version 11.2.0.4 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4 | 11.2.0.4.v5 | 11.2.0.4.v7 | 11.2.0.4.v8 PostgreSQL Version 9.5 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.5.2 | 9.5.4 Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.4.7 | 9.4.9 Version 9.4 (available in all AWS regions): 9.4.5 Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.4.1 | 9.4.4 Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.3.10 | 9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.3.1 | 9.3.2 Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.3.12 | 9.3.14 Microsoft SQL Server Enterprise Edition (sqlserver-ee) Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1 Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1 Microsoft SQL Server Express Edition (sqlserver-ex) Version 12.00 (available in all AWS regions): 12.00.4422.0.v1 Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1 Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1 Microsoft SQL Server Standard Edition (sqlserver-se) Version 12.00 (available in all AWS regions): 12.00.4422.0.v1 Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1 Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1 Microsoft SQL Server Web Edition (sqlserver-web) Version 12.00 (available in all AWS regions): 12.00.4422.0.v1 Version 11.00 (available in all AWS regions): 11.00.2100.60.v1 | 11.00.5058.0.v1 | 11.00.6020.0.v1 Version 10.50 (available in all AWS regions): 10.50.2789.0.v1 | 10.50.6000.34.v1 | 10.50.6529.0.v1
1153 */
1154 EngineVersion?: String;
1155 /**
1156 * Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default: true
1157 */
1158 AutoMinorVersionUpgrade?: BooleanOptional;
1159 /**
1160 * License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license
1161 */
1162 LicenseModel?: String;
1163 /**
1164 * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops value can be 2000, 3000, 4000, or 5000.
1165 */
1166 Iops?: IntegerOptional;
1167 /**
1168 * Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
1169 */
1170 OptionGroupName?: String;
1171 /**
1172 * For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
1173 */
1174 CharacterSetName?: String;
1175 /**
1176 * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. Default VPC: true VPC: false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
1177 */
1178 PubliclyAccessible?: BooleanOptional;
1179 Tags?: TagList;
1180 /**
1181 * The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String
1182 */
1183 DBClusterIdentifier?: String;
1184 /**
1185 * Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard
1186 */
1187 StorageType?: String;
1188 /**
1189 * The ARN from the Key Store with which to associate the instance for TDE encryption.
1190 */
1191 TdeCredentialArn?: String;
1192 /**
1193 * The password for the given ARN from the Key Store in order to access the device.
1194 */
1195 TdeCredentialPassword?: String;
1196 /**
1197 * Specifies whether the DB instance is encrypted. Default: false
1198 */
1199 StorageEncrypted?: BooleanOptional;
1200 /**
1201 * The KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
1202 */
1203 KmsKeyId?: String;
1204 /**
1205 * Specify the Active Directory Domain to create the instance in.
1206 */
1207 Domain?: String;
1208 /**
1209 * True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
1210 */
1211 CopyTagsToSnapshot?: BooleanOptional;
1212 /**
1213 * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
1214 */
1215 MonitoringInterval?: IntegerOptional;
1216 /**
1217 * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
1218 */
1219 MonitoringRoleArn?: String;
1220 /**
1221 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
1222 */
1223 DomainIAMRoleName?: String;
1224 /**
1225 * A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster. Default: 1 Valid Values: 0 - 15
1226 */
1227 PromotionTier?: IntegerOptional;
1228 /**
1229 * The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
1230 */
1231 Timezone?: String;
1232 }
1233 export interface CreateDBInstanceReadReplicaMessage {
1234 /**
1235 * The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
1236 */
1237 DBInstanceIdentifier: String;
1238 /**
1239 * The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas. Constraints: Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance. Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6. Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5. The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0. If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier. If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
1240 */
1241 SourceDBInstanceIdentifier: String;
1242 /**
1243 * The compute and memory capacity of the Read Replica. Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large Default: Inherits from the source DB instance.
1244 */
1245 DBInstanceClass?: String;
1246 /**
1247 * The Amazon EC2 Availability Zone that the Read Replica will be created in. Default: A random, system-chosen Availability Zone in the endpoint's region. Example: us-east-1d
1248 */
1249 AvailabilityZone?: String;
1250 /**
1251 * The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535
1252 */
1253 Port?: IntegerOptional;
1254 /**
1255 * Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance
1256 */
1257 AutoMinorVersionUpgrade?: BooleanOptional;
1258 /**
1259 * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
1260 */
1261 Iops?: IntegerOptional;
1262 /**
1263 * The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.
1264 */
1265 OptionGroupName?: String;
1266 /**
1267 * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. Default VPC:true VPC:false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
1268 */
1269 PubliclyAccessible?: BooleanOptional;
1270 Tags?: TagList;
1271 /**
1272 * Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC. Constraints: Can only be specified if the source DB instance identifier specifies a DB instance in another region. The specified DB subnet group must be in the same region in which the operation is running. All Read Replicas in one region that are created from the same source DB instance must either:> Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC. Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
1273 */
1274 DBSubnetGroupName?: String;
1275 /**
1276 * Specifies the storage type to be associated with the Read Replica. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard
1277 */
1278 StorageType?: String;
1279 /**
1280 * True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.
1281 */
1282 CopyTagsToSnapshot?: BooleanOptional;
1283 /**
1284 * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
1285 */
1286 MonitoringInterval?: IntegerOptional;
1287 /**
1288 * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
1289 */
1290 MonitoringRoleArn?: String;
1291 }
1292 export interface CreateDBInstanceReadReplicaResult {
1293 DBInstance?: DBInstance;
1294 }
1295 export interface CreateDBInstanceResult {
1296 DBInstance?: DBInstance;
1297 }
1298 export interface CreateDBParameterGroupMessage {
1299 /**
1300 * The name of the DB parameter group. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
1301 */
1302 DBParameterGroupName: String;
1303 /**
1304 * The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
1305 */
1306 DBParameterGroupFamily: String;
1307 /**
1308 * The description for the DB parameter group.
1309 */
1310 Description: String;
1311 Tags?: TagList;
1312 }
1313 export interface CreateDBParameterGroupResult {
1314 DBParameterGroup?: DBParameterGroup;
1315 }
1316 export interface CreateDBSecurityGroupMessage {
1317 /**
1318 * The name for the DB security group. This value is stored as a lowercase string. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Must not be "Default" Example: mysecuritygroup
1319 */
1320 DBSecurityGroupName: String;
1321 /**
1322 * The description for the DB security group.
1323 */
1324 DBSecurityGroupDescription: String;
1325 Tags?: TagList;
1326 }
1327 export interface CreateDBSecurityGroupResult {
1328 DBSecurityGroup?: DBSecurityGroup;
1329 }
1330 export interface CreateDBSnapshotMessage {
1331 /**
1332 * The identifier for the DB snapshot. Constraints: Cannot be null, empty, or blank Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
1333 */
1334 DBSnapshotIdentifier: String;
1335 /**
1336 * The DB instance identifier. This is the unique key that identifies a DB instance. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
1337 */
1338 DBInstanceIdentifier: String;
1339 Tags?: TagList;
1340 }
1341 export interface CreateDBSnapshotResult {
1342 DBSnapshot?: DBSnapshot;
1343 }
1344 export interface CreateDBSubnetGroupMessage {
1345 /**
1346 * The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
1347 */
1348 DBSubnetGroupName: String;
1349 /**
1350 * The description for the DB subnet group.
1351 */
1352 DBSubnetGroupDescription: String;
1353 /**
1354 * The EC2 Subnet IDs for the DB subnet group.
1355 */
1356 SubnetIds: SubnetIdentifierList;
1357 Tags?: TagList;
1358 }
1359 export interface CreateDBSubnetGroupResult {
1360 DBSubnetGroup?: DBSubnetGroup;
1361 }
1362 export interface CreateEventSubscriptionMessage {
1363 /**
1364 * The name of the subscription. Constraints: The name must be less than 255 characters.
1365 */
1366 SubscriptionName: String;
1367 /**
1368 * 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.
1369 */
1370 SnsTopicArn: String;
1371 /**
1372 * The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
1373 */
1374 SourceType?: String;
1375 /**
1376 * A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
1377 */
1378 EventCategories?: EventCategoriesList;
1379 /**
1380 * The list of identifiers of the event sources for which events will be 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 cannot end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds are supplied, SourceType must also be provided. If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
1381 */
1382 SourceIds?: SourceIdsList;
1383 /**
1384 * A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
1385 */
1386 Enabled?: BooleanOptional;
1387 Tags?: TagList;
1388 }
1389 export interface CreateEventSubscriptionResult {
1390 EventSubscription?: EventSubscription;
1391 }
1392 export interface CreateOptionGroupMessage {
1393 /**
1394 * Specifies the name of the option group to be created. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: myoptiongroup
1395 */
1396 OptionGroupName: String;
1397 /**
1398 * Specifies the name of the engine that this option group should be associated with.
1399 */
1400 EngineName: String;
1401 /**
1402 * Specifies the major version of the engine that this option group should be associated with.
1403 */
1404 MajorEngineVersion: String;
1405 /**
1406 * The description of the option group.
1407 */
1408 OptionGroupDescription: String;
1409 Tags?: TagList;
1410 }
1411 export interface CreateOptionGroupResult {
1412 OptionGroup?: OptionGroup;
1413 }
1414 export interface DBCluster {
1415 /**
1416 * Specifies the allocated storage size in gigabytes (GB).
1417 */
1418 AllocatedStorage?: IntegerOptional;
1419 /**
1420 * Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
1421 */
1422 AvailabilityZones?: AvailabilityZones;
1423 /**
1424 * Specifies the number of days for which automatic DB snapshots are retained.
1425 */
1426 BackupRetentionPeriod?: IntegerOptional;
1427 /**
1428 * If present, specifies the name of the character set that this cluster is associated with.
1429 */
1430 CharacterSetName?: String;
1431 /**
1432 * Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
1433 */
1434 DatabaseName?: String;
1435 /**
1436 * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
1437 */
1438 DBClusterIdentifier?: String;
1439 /**
1440 * Specifies the name of the DB cluster parameter group for the DB cluster.
1441 */
1442 DBClusterParameterGroup?: String;
1443 /**
1444 * Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
1445 */
1446 DBSubnetGroup?: String;
1447 /**
1448 * Specifies the current state of this DB cluster.
1449 */
1450 Status?: String;
1451 /**
1452 * Specifies the progress of the operation as a percentage.
1453 */
1454 PercentProgress?: String;
1455 /**
1456 * Specifies the earliest time to which a database can be restored with point-in-time restore.
1457 */
1458 EarliestRestorableTime?: TStamp;
1459 /**
1460 * Specifies the connection endpoint for the primary instance of the DB cluster.
1461 */
1462 Endpoint?: String;
1463 /**
1464 * The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then recoonect to the reader endpoint.
1465 */
1466 ReaderEndpoint?: String;
1467 /**
1468 * Provides the name of the database engine to be used for this DB cluster.
1469 */
1470 Engine?: String;
1471 /**
1472 * Indicates the database engine version.
1473 */
1474 EngineVersion?: String;
1475 /**
1476 * Specifies the latest time to which a database can be restored with point-in-time restore.
1477 */
1478 LatestRestorableTime?: TStamp;
1479 /**
1480 * Specifies the port that the database engine is listening on.
1481 */
1482 Port?: IntegerOptional;
1483 /**
1484 * Contains the master username for the DB cluster.
1485 */
1486 MasterUsername?: String;
1487 /**
1488 * Provides the list of option group memberships for this DB cluster.
1489 */
1490 DBClusterOptionGroupMemberships?: DBClusterOptionGroupMemberships;
1491 /**
1492 * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
1493 */
1494 PreferredBackupWindow?: String;
1495 /**
1496 * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
1497 */
1498 PreferredMaintenanceWindow?: String;
1499 /**
1500 * Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
1501 */
1502 ReplicationSourceIdentifier?: String;
1503 /**
1504 * Contains one or more identifiers of the Read Replicas associated with this DB cluster.
1505 */
1506 ReadReplicaIdentifiers?: ReadReplicaIdentifierList;
1507 /**
1508 * Provides the list of instances that make up the DB cluster.
1509 */
1510 DBClusterMembers?: DBClusterMemberList;
1511 /**
1512 * Provides a list of VPC security groups that the DB cluster belongs to.
1513 */
1514 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
1515 /**
1516 * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
1517 */
1518 HostedZoneId?: String;
1519 /**
1520 * Specifies whether the DB cluster is encrypted.
1521 */
1522 StorageEncrypted?: Boolean;
1523 /**
1524 * If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
1525 */
1526 KmsKeyId?: String;
1527 /**
1528 * The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
1529 */
1530 DbClusterResourceId?: String;
1531 /**
1532 * The Amazon Resource Name (ARN) for the DB cluster.
1533 */
1534 DBClusterArn?: String;
1535 /**
1536 * Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
1537 */
1538 AssociatedRoles?: DBClusterRoles;
1539 }
1540 export type DBClusterList = DBCluster[];
1541 export interface DBClusterMember {
1542 /**
1543 * Specifies the instance identifier for this member of the DB cluster.
1544 */
1545 DBInstanceIdentifier?: String;
1546 /**
1547 * Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
1548 */
1549 IsClusterWriter?: Boolean;
1550 /**
1551 * Specifies the status of the DB cluster parameter group for this member of the DB cluster.
1552 */
1553 DBClusterParameterGroupStatus?: String;
1554 /**
1555 * A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
1556 */
1557 PromotionTier?: IntegerOptional;
1558 }
1559 export type DBClusterMemberList = DBClusterMember[];
1560 export interface DBClusterMessage {
1561 /**
1562 * A pagination token that can be used in a subsequent DescribeDBClusters request.
1563 */
1564 Marker?: String;
1565 /**
1566 * Contains a list of DB clusters for the user.
1567 */
1568 DBClusters?: DBClusterList;
1569 }
1570 export type DBClusterOptionGroupMemberships = DBClusterOptionGroupStatus[];
1571 export interface DBClusterOptionGroupStatus {
1572 /**
1573 * Specifies the name of the DB cluster option group.
1574 */
1575 DBClusterOptionGroupName?: String;
1576 /**
1577 * Specifies the status of the DB cluster option group.
1578 */
1579 Status?: String;
1580 }
1581 export interface DBClusterParameterGroup {
1582 /**
1583 * Provides the name of the DB cluster parameter group.
1584 */
1585 DBClusterParameterGroupName?: String;
1586 /**
1587 * Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
1588 */
1589 DBParameterGroupFamily?: String;
1590 /**
1591 * Provides the customer-specified description for this DB cluster parameter group.
1592 */
1593 Description?: String;
1594 /**
1595 * The Amazon Resource Name (ARN) for the DB cluster parameter group.
1596 */
1597 DBClusterParameterGroupArn?: String;
1598 }
1599 export interface DBClusterParameterGroupDetails {
1600 /**
1601 * Provides a list of parameters for the DB cluster parameter group.
1602 */
1603 Parameters?: ParametersList;
1604 /**
1605 * An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
1606 */
1607 Marker?: String;
1608 }
1609 export type DBClusterParameterGroupList = DBClusterParameterGroup[];
1610 export interface DBClusterParameterGroupNameMessage {
1611 /**
1612 * The name of the DB cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
1613 */
1614 DBClusterParameterGroupName?: String;
1615 }
1616 export interface DBClusterParameterGroupsMessage {
1617 /**
1618 * An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1619 */
1620 Marker?: String;
1621 /**
1622 * A list of DB cluster parameter groups.
1623 */
1624 DBClusterParameterGroups?: DBClusterParameterGroupList;
1625 }
1626 export interface DBClusterRole {
1627 /**
1628 * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
1629 */
1630 RoleArn?: String;
1631 /**
1632 * Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf. PENDING - the IAM role ARN is being associated with the DB cluster. INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.
1633 */
1634 Status?: String;
1635 }
1636 export type DBClusterRoles = DBClusterRole[];
1637 export interface DBClusterSnapshot {
1638 /**
1639 * Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
1640 */
1641 AvailabilityZones?: AvailabilityZones;
1642 /**
1643 * Specifies the identifier for the DB cluster snapshot.
1644 */
1645 DBClusterSnapshotIdentifier?: String;
1646 /**
1647 * Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
1648 */
1649 DBClusterIdentifier?: String;
1650 /**
1651 * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
1652 */
1653 SnapshotCreateTime?: TStamp;
1654 /**
1655 * Specifies the name of the database engine.
1656 */
1657 Engine?: String;
1658 /**
1659 * Specifies the allocated storage size in gigabytes (GB).
1660 */
1661 AllocatedStorage?: Integer;
1662 /**
1663 * Specifies the status of this DB cluster snapshot.
1664 */
1665 Status?: String;
1666 /**
1667 * Specifies the port that the DB cluster was listening on at the time of the snapshot.
1668 */
1669 Port?: Integer;
1670 /**
1671 * Provides the VPC ID associated with the DB cluster snapshot.
1672 */
1673 VpcId?: String;
1674 /**
1675 * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
1676 */
1677 ClusterCreateTime?: TStamp;
1678 /**
1679 * Provides the master username for the DB cluster snapshot.
1680 */
1681 MasterUsername?: String;
1682 /**
1683 * Provides the version of the database engine for this DB cluster snapshot.
1684 */
1685 EngineVersion?: String;
1686 /**
1687 * Provides the license model information for this DB cluster snapshot.
1688 */
1689 LicenseModel?: String;
1690 /**
1691 * Provides the type of the DB cluster snapshot.
1692 */
1693 SnapshotType?: String;
1694 /**
1695 * Specifies the percentage of the estimated data that has been transferred.
1696 */
1697 PercentProgress?: Integer;
1698 /**
1699 * Specifies whether the DB cluster snapshot is encrypted.
1700 */
1701 StorageEncrypted?: Boolean;
1702 /**
1703 * If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.
1704 */
1705 KmsKeyId?: String;
1706 /**
1707 * The Amazon Resource Name (ARN) for the DB cluster snapshot.
1708 */
1709 DBClusterSnapshotArn?: String;
1710 }
1711 export interface DBClusterSnapshotAttribute {
1712 /**
1713 * The name of the manual DB cluster snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
1714 */
1715 AttributeName?: String;
1716 /**
1717 * The value(s) for the manual DB cluster snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.
1718 */
1719 AttributeValues?: AttributeValueList;
1720 }
1721 export type DBClusterSnapshotAttributeList = DBClusterSnapshotAttribute[];
1722 export interface DBClusterSnapshotAttributesResult {
1723 /**
1724 * The identifier of the manual DB cluster snapshot that the attributes apply to.
1725 */
1726 DBClusterSnapshotIdentifier?: String;
1727 /**
1728 * The list of attributes and values for the manual DB cluster snapshot.
1729 */
1730 DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList;
1731 }
1732 export type DBClusterSnapshotList = DBClusterSnapshot[];
1733 export interface DBClusterSnapshotMessage {
1734 /**
1735 * An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
1736 */
1737 Marker?: String;
1738 /**
1739 * Provides a list of DB cluster snapshots for the user.
1740 */
1741 DBClusterSnapshots?: DBClusterSnapshotList;
1742 }
1743 export interface DBEngineVersion {
1744 /**
1745 * The name of the database engine.
1746 */
1747 Engine?: String;
1748 /**
1749 * The version number of the database engine.
1750 */
1751 EngineVersion?: String;
1752 /**
1753 * The name of the DB parameter group family for the database engine.
1754 */
1755 DBParameterGroupFamily?: String;
1756 /**
1757 * The description of the database engine.
1758 */
1759 DBEngineDescription?: String;
1760 /**
1761 * The description of the database engine version.
1762 */
1763 DBEngineVersionDescription?: String;
1764 /**
1765 * The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
1766 */
1767 DefaultCharacterSet?: CharacterSet;
1768 /**
1769 * A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.
1770 */
1771 SupportedCharacterSets?: SupportedCharacterSetsList;
1772 /**
1773 * A list of engine versions that this database engine version can be upgraded to.
1774 */
1775 ValidUpgradeTarget?: ValidUpgradeTargetList;
1776 /**
1777 * A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
1778 */
1779 SupportedTimezones?: SupportedTimezonesList;
1780 }
1781 export type DBEngineVersionList = DBEngineVersion[];
1782 export interface DBEngineVersionMessage {
1783 /**
1784 * 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.
1785 */
1786 Marker?: String;
1787 /**
1788 * A list of DBEngineVersion elements.
1789 */
1790 DBEngineVersions?: DBEngineVersionList;
1791 }
1792 export interface DBInstance {
1793 /**
1794 * Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
1795 */
1796 DBInstanceIdentifier?: String;
1797 /**
1798 * Contains the name of the compute and memory capacity class of the DB instance.
1799 */
1800 DBInstanceClass?: String;
1801 /**
1802 * Provides the name of the database engine to be used for this DB instance.
1803 */
1804 Engine?: String;
1805 /**
1806 * Specifies the current state of this database.
1807 */
1808 DBInstanceStatus?: String;
1809 /**
1810 * Contains the master username for the DB instance.
1811 */
1812 MasterUsername?: String;
1813 /**
1814 * The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines. MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
1815 */
1816 DBName?: String;
1817 /**
1818 * Specifies the connection endpoint.
1819 */
1820 Endpoint?: Endpoint;
1821 /**
1822 * Specifies the allocated storage size specified in gigabytes.
1823 */
1824 AllocatedStorage?: Integer;
1825 /**
1826 * Provides the date and time the DB instance was created.
1827 */
1828 InstanceCreateTime?: TStamp;
1829 /**
1830 * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
1831 */
1832 PreferredBackupWindow?: String;
1833 /**
1834 * Specifies the number of days for which automatic DB snapshots are retained.
1835 */
1836 BackupRetentionPeriod?: Integer;
1837 /**
1838 * Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
1839 */
1840 DBSecurityGroups?: DBSecurityGroupMembershipList;
1841 /**
1842 * Provides a list of VPC security group elements that the DB instance belongs to.
1843 */
1844 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
1845 /**
1846 * Provides the list of DB parameter groups applied to this DB instance.
1847 */
1848 DBParameterGroups?: DBParameterGroupStatusList;
1849 /**
1850 * Specifies the name of the Availability Zone the DB instance is located in.
1851 */
1852 AvailabilityZone?: String;
1853 /**
1854 * Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
1855 */
1856 DBSubnetGroup?: DBSubnetGroup;
1857 /**
1858 * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
1859 */
1860 PreferredMaintenanceWindow?: String;
1861 /**
1862 * Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
1863 */
1864 PendingModifiedValues?: PendingModifiedValues;
1865 /**
1866 * Specifies the latest time to which a database can be restored with point-in-time restore.
1867 */
1868 LatestRestorableTime?: TStamp;
1869 /**
1870 * Specifies if the DB instance is a Multi-AZ deployment.
1871 */
1872 MultiAZ?: Boolean;
1873 /**
1874 * Indicates the database engine version.
1875 */
1876 EngineVersion?: String;
1877 /**
1878 * Indicates that minor version patches are applied automatically.
1879 */
1880 AutoMinorVersionUpgrade?: Boolean;
1881 /**
1882 * Contains the identifier of the source DB instance if this DB instance is a Read Replica.
1883 */
1884 ReadReplicaSourceDBInstanceIdentifier?: String;
1885 /**
1886 * Contains one or more identifiers of the Read Replicas associated with this DB instance.
1887 */
1888 ReadReplicaDBInstanceIdentifiers?: ReadReplicaDBInstanceIdentifierList;
1889 /**
1890 * License model information for this DB instance.
1891 */
1892 LicenseModel?: String;
1893 /**
1894 * Specifies the Provisioned IOPS (I/O operations per second) value.
1895 */
1896 Iops?: IntegerOptional;
1897 /**
1898 * Provides the list of option group memberships for this DB instance.
1899 */
1900 OptionGroupMemberships?: OptionGroupMembershipList;
1901 /**
1902 * If present, specifies the name of the character set that this instance is associated with.
1903 */
1904 CharacterSetName?: String;
1905 /**
1906 * If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
1907 */
1908 SecondaryAvailabilityZone?: String;
1909 /**
1910 * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. Default VPC:true VPC:false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
1911 */
1912 PubliclyAccessible?: Boolean;
1913 /**
1914 * The status of a Read Replica. If the instance is not a Read Replica, this will be blank.
1915 */
1916 StatusInfos?: DBInstanceStatusInfoList;
1917 /**
1918 * Specifies the storage type associated with DB instance.
1919 */
1920 StorageType?: String;
1921 /**
1922 * The ARN from the key store with which the instance is associated for TDE encryption.
1923 */
1924 TdeCredentialArn?: String;
1925 /**
1926 * Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
1927 */
1928 DbInstancePort?: Integer;
1929 /**
1930 * If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
1931 */
1932 DBClusterIdentifier?: String;
1933 /**
1934 * Specifies whether the DB instance is encrypted.
1935 */
1936 StorageEncrypted?: Boolean;
1937 /**
1938 * If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
1939 */
1940 KmsKeyId?: String;
1941 /**
1942 * The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.
1943 */
1944 DbiResourceId?: String;
1945 /**
1946 * The identifier of the CA certificate for this DB instance.
1947 */
1948 CACertificateIdentifier?: String;
1949 /**
1950 * The Active Directory Domain membership records associated with the DB instance.
1951 */
1952 DomainMemberships?: DomainMembershipList;
1953 /**
1954 * Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
1955 */
1956 CopyTagsToSnapshot?: Boolean;
1957 /**
1958 * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
1959 */
1960 MonitoringInterval?: IntegerOptional;
1961 /**
1962 * The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
1963 */
1964 EnhancedMonitoringResourceArn?: String;
1965 /**
1966 * The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
1967 */
1968 MonitoringRoleArn?: String;
1969 /**
1970 * A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
1971 */
1972 PromotionTier?: IntegerOptional;
1973 /**
1974 * The Amazon Resource Name (ARN) for the DB instance.
1975 */
1976 DBInstanceArn?: String;
1977 /**
1978 * The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
1979 */
1980 Timezone?: String;
1981 }
1982 export type DBInstanceList = DBInstance[];
1983 export interface DBInstanceMessage {
1984 /**
1985 * 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 .
1986 */
1987 Marker?: String;
1988 /**
1989 * A list of DBInstance instances.
1990 */
1991 DBInstances?: DBInstanceList;
1992 }
1993 export interface DBInstanceStatusInfo {
1994 /**
1995 * This value is currently "read replication."
1996 */
1997 StatusType?: String;
1998 /**
1999 * Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
2000 */
2001 Normal?: Boolean;
2002 /**
2003 * Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
2004 */
2005 Status?: String;
2006 /**
2007 * 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.
2008 */
2009 Message?: String;
2010 }
2011 export type DBInstanceStatusInfoList = DBInstanceStatusInfo[];
2012 export interface DBParameterGroup {
2013 /**
2014 * Provides the name of the DB parameter group.
2015 */
2016 DBParameterGroupName?: String;
2017 /**
2018 * Provides the name of the DB parameter group family that this DB parameter group is compatible with.
2019 */
2020 DBParameterGroupFamily?: String;
2021 /**
2022 * Provides the customer-specified description for this DB parameter group.
2023 */
2024 Description?: String;
2025 /**
2026 * The Amazon Resource Name (ARN) for the DB parameter group.
2027 */
2028 DBParameterGroupArn?: String;
2029 }
2030 export interface DBParameterGroupDetails {
2031 /**
2032 * A list of Parameter values.
2033 */
2034 Parameters?: ParametersList;
2035 /**
2036 * 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.
2037 */
2038 Marker?: String;
2039 }
2040 export type DBParameterGroupList = DBParameterGroup[];
2041 export interface DBParameterGroupNameMessage {
2042 /**
2043 * Provides the name of the DB parameter group.
2044 */
2045 DBParameterGroupName?: String;
2046 }
2047 export interface DBParameterGroupStatus {
2048 /**
2049 * The name of the DP parameter group.
2050 */
2051 DBParameterGroupName?: String;
2052 /**
2053 * The status of parameter updates.
2054 */
2055 ParameterApplyStatus?: String;
2056 }
2057 export type DBParameterGroupStatusList = DBParameterGroupStatus[];
2058 export interface DBParameterGroupsMessage {
2059 /**
2060 * 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.
2061 */
2062 Marker?: String;
2063 /**
2064 * A list of DBParameterGroup instances.
2065 */
2066 DBParameterGroups?: DBParameterGroupList;
2067 }
2068 export interface DBSecurityGroup {
2069 /**
2070 * Provides the AWS ID of the owner of a specific DB security group.
2071 */
2072 OwnerId?: String;
2073 /**
2074 * Specifies the name of the DB security group.
2075 */
2076 DBSecurityGroupName?: String;
2077 /**
2078 * Provides the description of the DB security group.
2079 */
2080 DBSecurityGroupDescription?: String;
2081 /**
2082 * Provides the VpcId of the DB security group.
2083 */
2084 VpcId?: String;
2085 /**
2086 * Contains a list of EC2SecurityGroup elements.
2087 */
2088 EC2SecurityGroups?: EC2SecurityGroupList;
2089 /**
2090 * Contains a list of IPRange elements.
2091 */
2092 IPRanges?: IPRangeList;
2093 /**
2094 * The Amazon Resource Name (ARN) for the DB security group.
2095 */
2096 DBSecurityGroupArn?: String;
2097 }
2098 export interface DBSecurityGroupMembership {
2099 /**
2100 * The name of the DB security group.
2101 */
2102 DBSecurityGroupName?: String;
2103 /**
2104 * The status of the DB security group.
2105 */
2106 Status?: String;
2107 }
2108 export type DBSecurityGroupMembershipList = DBSecurityGroupMembership[];
2109 export interface DBSecurityGroupMessage {
2110 /**
2111 * 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.
2112 */
2113 Marker?: String;
2114 /**
2115 * A list of DBSecurityGroup instances.
2116 */
2117 DBSecurityGroups?: DBSecurityGroups;
2118 }
2119 export type DBSecurityGroupNameList = String[];
2120 export type DBSecurityGroups = DBSecurityGroup[];
2121 export interface DBSnapshot {
2122 /**
2123 * Specifies the identifier for the DB snapshot.
2124 */
2125 DBSnapshotIdentifier?: String;
2126 /**
2127 * Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
2128 */
2129 DBInstanceIdentifier?: String;
2130 /**
2131 * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
2132 */
2133 SnapshotCreateTime?: TStamp;
2134 /**
2135 * Specifies the name of the database engine.
2136 */
2137 Engine?: String;
2138 /**
2139 * Specifies the allocated storage size in gigabytes (GB).
2140 */
2141 AllocatedStorage?: Integer;
2142 /**
2143 * Specifies the status of this DB snapshot.
2144 */
2145 Status?: String;
2146 /**
2147 * Specifies the port that the database engine was listening on at the time of the snapshot.
2148 */
2149 Port?: Integer;
2150 /**
2151 * Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
2152 */
2153 AvailabilityZone?: String;
2154 /**
2155 * Provides the VPC ID associated with the DB snapshot.
2156 */
2157 VpcId?: String;
2158 /**
2159 * Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
2160 */
2161 InstanceCreateTime?: TStamp;
2162 /**
2163 * Provides the master username for the DB snapshot.
2164 */
2165 MasterUsername?: String;
2166 /**
2167 * Specifies the version of the database engine.
2168 */
2169 EngineVersion?: String;
2170 /**
2171 * License model information for the restored DB instance.
2172 */
2173 LicenseModel?: String;
2174 /**
2175 * Provides the type of the DB snapshot.
2176 */
2177 SnapshotType?: String;
2178 /**
2179 * Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
2180 */
2181 Iops?: IntegerOptional;
2182 /**
2183 * Provides the option group name for the DB snapshot.
2184 */
2185 OptionGroupName?: String;
2186 /**
2187 * The percentage of the estimated data that has been transferred.
2188 */
2189 PercentProgress?: Integer;
2190 /**
2191 * The region that the DB snapshot was created in or copied from.
2192 */
2193 SourceRegion?: String;
2194 /**
2195 * The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
2196 */
2197 SourceDBSnapshotIdentifier?: String;
2198 /**
2199 * Specifies the storage type associated with DB snapshot.
2200 */
2201 StorageType?: String;
2202 /**
2203 * The ARN from the key store with which to associate the instance for TDE encryption.
2204 */
2205 TdeCredentialArn?: String;
2206 /**
2207 * Specifies whether the DB snapshot is encrypted.
2208 */
2209 Encrypted?: Boolean;
2210 /**
2211 * If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
2212 */
2213 KmsKeyId?: String;
2214 /**
2215 * The Amazon Resource Name (ARN) for the DB snapshot.
2216 */
2217 DBSnapshotArn?: String;
2218 /**
2219 * The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
2220 */
2221 Timezone?: String;
2222 }
2223 export interface DBSnapshotAttribute {
2224 /**
2225 * The name of the manual DB snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
2226 */
2227 AttributeName?: String;
2228 /**
2229 * The value or values for the manual DB snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore.
2230 */
2231 AttributeValues?: AttributeValueList;
2232 }
2233 export type DBSnapshotAttributeList = DBSnapshotAttribute[];
2234 export interface DBSnapshotAttributesResult {
2235 /**
2236 * The identifier of the manual DB snapshot that the attributes apply to.
2237 */
2238 DBSnapshotIdentifier?: String;
2239 /**
2240 * The list of attributes and values for the manual DB snapshot.
2241 */
2242 DBSnapshotAttributes?: DBSnapshotAttributeList;
2243 }
2244 export type DBSnapshotList = DBSnapshot[];
2245 export interface DBSnapshotMessage {
2246 /**
2247 * 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.
2248 */
2249 Marker?: String;
2250 /**
2251 * A list of DBSnapshot instances.
2252 */
2253 DBSnapshots?: DBSnapshotList;
2254 }
2255 export interface DBSubnetGroup {
2256 /**
2257 * The name of the DB subnet group.
2258 */
2259 DBSubnetGroupName?: String;
2260 /**
2261 * Provides the description of the DB subnet group.
2262 */
2263 DBSubnetGroupDescription?: String;
2264 /**
2265 * Provides the VpcId of the DB subnet group.
2266 */
2267 VpcId?: String;
2268 /**
2269 * Provides the status of the DB subnet group.
2270 */
2271 SubnetGroupStatus?: String;
2272 /**
2273 * Contains a list of Subnet elements.
2274 */
2275 Subnets?: SubnetList;
2276 /**
2277 * The Amazon Resource Name (ARN) for the DB subnet group.
2278 */
2279 DBSubnetGroupArn?: String;
2280 }
2281 export interface DBSubnetGroupMessage {
2282 /**
2283 * 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.
2284 */
2285 Marker?: String;
2286 /**
2287 * A list of DBSubnetGroup instances.
2288 */
2289 DBSubnetGroups?: DBSubnetGroups;
2290 }
2291 export type DBSubnetGroups = DBSubnetGroup[];
2292 export interface DeleteDBClusterMessage {
2293 /**
2294 * The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2295 */
2296 DBClusterIdentifier: String;
2297 /**
2298 * Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted. You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false. Default: false
2299 */
2300 SkipFinalSnapshot?: Boolean;
2301 /**
2302 * The DB cluster snapshot identifier of the new DB 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 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2303 */
2304 FinalDBSnapshotIdentifier?: String;
2305 }
2306 export interface DeleteDBClusterParameterGroupMessage {
2307 /**
2308 * The name of the DB cluster parameter group. Constraints: Must be the name of an existing DB cluster parameter group. You cannot delete a default DB cluster parameter group. Cannot be associated with any DB clusters.
2309 */
2310 DBClusterParameterGroupName: String;
2311 }
2312 export interface DeleteDBClusterResult {
2313 DBCluster?: DBCluster;
2314 }
2315 export interface DeleteDBClusterSnapshotMessage {
2316 /**
2317 * The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state.
2318 */
2319 DBClusterSnapshotIdentifier: String;
2320 }
2321 export interface DeleteDBClusterSnapshotResult {
2322 DBClusterSnapshot?: DBClusterSnapshot;
2323 }
2324 export interface DeleteDBInstanceMessage {
2325 /**
2326 * The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2327 */
2328 DBInstanceIdentifier: String;
2329 /**
2330 * Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted. Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". Specify true when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false. Default: false
2331 */
2332 SkipFinalSnapshot?: Boolean;
2333 /**
2334 * The DBSnapshotIdentifier of the new DBSnapshot 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 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Cannot be specified when deleting a Read Replica.
2335 */
2336 FinalDBSnapshotIdentifier?: String;
2337 }
2338 export interface DeleteDBInstanceResult {
2339 DBInstance?: DBInstance;
2340 }
2341 export interface DeleteDBParameterGroupMessage {
2342 /**
2343 * The name of the DB parameter group. Constraints: Must be the name of an existing DB parameter group You cannot delete a default DB parameter group Cannot be associated with any DB instances
2344 */
2345 DBParameterGroupName: String;
2346 }
2347 export interface DeleteDBSecurityGroupMessage {
2348 /**
2349 * The name of the DB security group to delete. You cannot delete the default DB security group. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Must not be "Default"
2350 */
2351 DBSecurityGroupName: String;
2352 }
2353 export interface DeleteDBSnapshotMessage {
2354 /**
2355 * The DBSnapshot identifier. Constraints: Must be the name of an existing DB snapshot in the available state.
2356 */
2357 DBSnapshotIdentifier: String;
2358 }
2359 export interface DeleteDBSnapshotResult {
2360 DBSnapshot?: DBSnapshot;
2361 }
2362 export interface DeleteDBSubnetGroupMessage {
2363 /**
2364 * The name of the database subnet group to delete. You cannot delete the default subnet group. Constraints: Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
2365 */
2366 DBSubnetGroupName: String;
2367 }
2368 export interface DeleteEventSubscriptionMessage {
2369 /**
2370 * The name of the RDS event notification subscription you want to delete.
2371 */
2372 SubscriptionName: String;
2373 }
2374 export interface DeleteEventSubscriptionResult {
2375 EventSubscription?: EventSubscription;
2376 }
2377 export interface DeleteOptionGroupMessage {
2378 /**
2379 * The name of the option group to be deleted. You cannot delete default option groups.
2380 */
2381 OptionGroupName: String;
2382 }
2383 export interface DescribeAccountAttributesMessage {
2384 }
2385 export interface DescribeCertificatesMessage {
2386 /**
2387 * The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2388 */
2389 CertificateIdentifier?: String;
2390 /**
2391 * This parameter is not currently supported.
2392 */
2393 Filters?: FilterList;
2394 /**
2395 * 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.
2396 */
2397 MaxRecords?: IntegerOptional;
2398 /**
2399 * 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.
2400 */
2401 Marker?: String;
2402 }
2403 export interface DescribeDBClusterParameterGroupsMessage {
2404 /**
2405 * The name of a specific DB cluster parameter group to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2406 */
2407 DBClusterParameterGroupName?: String;
2408 /**
2409 * This parameter is not currently supported.
2410 */
2411 Filters?: FilterList;
2412 /**
2413 * 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.
2414 */
2415 MaxRecords?: IntegerOptional;
2416 /**
2417 * An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2418 */
2419 Marker?: String;
2420 }
2421 export interface DescribeDBClusterParametersMessage {
2422 /**
2423 * The name of a specific DB cluster parameter group to return parameter details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2424 */
2425 DBClusterParameterGroupName: String;
2426 /**
2427 * A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
2428 */
2429 Source?: String;
2430 /**
2431 * This parameter is not currently supported.
2432 */
2433 Filters?: FilterList;
2434 /**
2435 * 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.
2436 */
2437 MaxRecords?: IntegerOptional;
2438 /**
2439 * An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2440 */
2441 Marker?: String;
2442 }
2443 export interface DescribeDBClusterSnapshotAttributesMessage {
2444 /**
2445 * The identifier for the DB cluster snapshot to describe the attributes for.
2446 */
2447 DBClusterSnapshotIdentifier: String;
2448 }
2449 export interface DescribeDBClusterSnapshotAttributesResult {
2450 DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
2451 }
2452 export interface DescribeDBClusterSnapshotsMessage {
2453 /**
2454 * The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2455 */
2456 DBClusterIdentifier?: String;
2457 /**
2458 * A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
2459 */
2460 DBClusterSnapshotIdentifier?: String;
2461 /**
2462 * The type of DB cluster snapshots to be returned. You can specify one of the following values: automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account. manual - Return all DB cluster snapshots that have been taken by my AWS account. shared - Return all manual DB cluster snapshots that have been shared to my AWS account. public - Return all DB cluster snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic 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.
2463 */
2464 SnapshotType?: String;
2465 /**
2466 * This parameter is not currently supported.
2467 */
2468 Filters?: FilterList;
2469 /**
2470 * 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.
2471 */
2472 MaxRecords?: IntegerOptional;
2473 /**
2474 * An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2475 */
2476 Marker?: String;
2477 /**
2478 * Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false. You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
2479 */
2480 IncludeShared?: Boolean;
2481 /**
2482 * Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false. The default is false. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
2483 */
2484 IncludePublic?: Boolean;
2485 }
2486 export interface DescribeDBClustersMessage {
2487 /**
2488 * The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2489 */
2490 DBClusterIdentifier?: String;
2491 /**
2492 * This parameter is not currently supported.
2493 */
2494 Filters?: FilterList;
2495 /**
2496 * 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.
2497 */
2498 MaxRecords?: IntegerOptional;
2499 /**
2500 * An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2501 */
2502 Marker?: String;
2503 }
2504 export interface DescribeDBEngineVersionsMessage {
2505 /**
2506 * The database engine to return.
2507 */
2508 Engine?: String;
2509 /**
2510 * The database engine version to return. Example: 5.1.49
2511 */
2512 EngineVersion?: String;
2513 /**
2514 * The name of a specific DB parameter group family to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2515 */
2516 DBParameterGroupFamily?: String;
2517 /**
2518 * Not currently supported.
2519 */
2520 Filters?: FilterList;
2521 /**
2522 * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
2523 */
2524 MaxRecords?: IntegerOptional;
2525 /**
2526 * 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.
2527 */
2528 Marker?: String;
2529 /**
2530 * Indicates that only the default version of the specified engine or engine and major version combination is returned.
2531 */
2532 DefaultOnly?: Boolean;
2533 /**
2534 * 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.
2535 */
2536 ListSupportedCharacterSets?: BooleanOptional;
2537 /**
2538 * 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.
2539 */
2540 ListSupportedTimezones?: BooleanOptional;
2541 }
2542 export interface DescribeDBInstancesMessage {
2543 /**
2544 * The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2545 */
2546 DBInstanceIdentifier?: String;
2547 /**
2548 * This parameter is not currently supported.
2549 */
2550 Filters?: FilterList;
2551 /**
2552 * 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.
2553 */
2554 MaxRecords?: IntegerOptional;
2555 /**
2556 * An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2557 */
2558 Marker?: String;
2559 }
2560 export interface DescribeDBLogFilesDetails {
2561 /**
2562 * The name of the log file for the specified DB instance.
2563 */
2564 LogFileName?: String;
2565 /**
2566 * A POSIX timestamp when the last log entry was written.
2567 */
2568 LastWritten?: Long;
2569 /**
2570 * The size, in bytes, of the log file for the specified DB instance.
2571 */
2572 Size?: Long;
2573 }
2574 export type DescribeDBLogFilesList = DescribeDBLogFilesDetails[];
2575 export interface DescribeDBLogFilesMessage {
2576 /**
2577 * The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2578 */
2579 DBInstanceIdentifier: String;
2580 /**
2581 * Filters the available log files for log file names that contain the specified string.
2582 */
2583 FilenameContains?: String;
2584 /**
2585 * Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
2586 */
2587 FileLastWritten?: Long;
2588 /**
2589 * Filters the available log files for files larger than the specified size.
2590 */
2591 FileSize?: Long;
2592 /**
2593 * This parameter is not currently supported.
2594 */
2595 Filters?: FilterList;
2596 /**
2597 * 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.
2598 */
2599 MaxRecords?: IntegerOptional;
2600 /**
2601 * The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
2602 */
2603 Marker?: String;
2604 }
2605 export interface DescribeDBLogFilesResponse {
2606 /**
2607 * The DB log files returned.
2608 */
2609 DescribeDBLogFiles?: DescribeDBLogFilesList;
2610 /**
2611 * A pagination token that can be used in a subsequent DescribeDBLogFiles request.
2612 */
2613 Marker?: String;
2614 }
2615 export interface DescribeDBParameterGroupsMessage {
2616 /**
2617 * The name of a specific DB parameter group to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2618 */
2619 DBParameterGroupName?: String;
2620 /**
2621 * This parameter is not currently supported.
2622 */
2623 Filters?: FilterList;
2624 /**
2625 * 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.
2626 */
2627 MaxRecords?: IntegerOptional;
2628 /**
2629 * An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2630 */
2631 Marker?: String;
2632 }
2633 export interface DescribeDBParametersMessage {
2634 /**
2635 * The name of a specific DB parameter group to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2636 */
2637 DBParameterGroupName: String;
2638 /**
2639 * The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default
2640 */
2641 Source?: String;
2642 /**
2643 * This parameter is not currently supported.
2644 */
2645 Filters?: FilterList;
2646 /**
2647 * 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.
2648 */
2649 MaxRecords?: IntegerOptional;
2650 /**
2651 * An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2652 */
2653 Marker?: String;
2654 }
2655 export interface DescribeDBSecurityGroupsMessage {
2656 /**
2657 * The name of the DB security group to return details for.
2658 */
2659 DBSecurityGroupName?: String;
2660 /**
2661 * This parameter is not currently supported.
2662 */
2663 Filters?: FilterList;
2664 /**
2665 * 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.
2666 */
2667 MaxRecords?: IntegerOptional;
2668 /**
2669 * An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2670 */
2671 Marker?: String;
2672 }
2673 export interface DescribeDBSnapshotAttributesMessage {
2674 /**
2675 * The identifier for the DB snapshot to describe the attributes for.
2676 */
2677 DBSnapshotIdentifier: String;
2678 }
2679 export interface DescribeDBSnapshotAttributesResult {
2680 DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
2681 }
2682 export interface DescribeDBSnapshotsMessage {
2683 /**
2684 * The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
2685 */
2686 DBInstanceIdentifier?: String;
2687 /**
2688 * A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string. Constraints: Must be 1 to 255 alphanumeric characters. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
2689 */
2690 DBSnapshotIdentifier?: String;
2691 /**
2692 * The type of snapshots to be returned. You can specify one of the following values: automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account. manual - Return all DB snapshots that have been taken by my AWS account. shared - Return all manual DB snapshots that have been shared to my AWS account. public - Return all DB snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic 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.
2693 */
2694 SnapshotType?: String;
2695 /**
2696 * This parameter is not currently supported.
2697 */
2698 Filters?: FilterList;
2699 /**
2700 * 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.
2701 */
2702 MaxRecords?: IntegerOptional;
2703 /**
2704 * An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2705 */
2706 Marker?: String;
2707 /**
2708 * Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false. You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
2709 */
2710 IncludeShared?: Boolean;
2711 /**
2712 * Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
2713 */
2714 IncludePublic?: Boolean;
2715 }
2716 export interface DescribeDBSubnetGroupsMessage {
2717 /**
2718 * The name of the DB subnet group to return details for.
2719 */
2720 DBSubnetGroupName?: String;
2721 /**
2722 * This parameter is not currently supported.
2723 */
2724 Filters?: FilterList;
2725 /**
2726 * 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.
2727 */
2728 MaxRecords?: IntegerOptional;
2729 /**
2730 * An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2731 */
2732 Marker?: String;
2733 }
2734 export interface DescribeEngineDefaultClusterParametersMessage {
2735 /**
2736 * The name of the DB cluster parameter group family to return engine parameter information for.
2737 */
2738 DBParameterGroupFamily: String;
2739 /**
2740 * This parameter is not currently supported.
2741 */
2742 Filters?: FilterList;
2743 /**
2744 * 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.
2745 */
2746 MaxRecords?: IntegerOptional;
2747 /**
2748 * An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2749 */
2750 Marker?: String;
2751 }
2752 export interface DescribeEngineDefaultClusterParametersResult {
2753 EngineDefaults?: EngineDefaults;
2754 }
2755 export interface DescribeEngineDefaultParametersMessage {
2756 /**
2757 * The name of the DB parameter group family.
2758 */
2759 DBParameterGroupFamily: String;
2760 /**
2761 * Not currently supported.
2762 */
2763 Filters?: FilterList;
2764 /**
2765 * 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.
2766 */
2767 MaxRecords?: IntegerOptional;
2768 /**
2769 * An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2770 */
2771 Marker?: String;
2772 }
2773 export interface DescribeEngineDefaultParametersResult {
2774 EngineDefaults?: EngineDefaults;
2775 }
2776 export interface DescribeEventCategoriesMessage {
2777 /**
2778 * The type of source that will be generating the events. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
2779 */
2780 SourceType?: String;
2781 /**
2782 * This parameter is not currently supported.
2783 */
2784 Filters?: FilterList;
2785 }
2786 export interface DescribeEventSubscriptionsMessage {
2787 /**
2788 * The name of the RDS event notification subscription you want to describe.
2789 */
2790 SubscriptionName?: String;
2791 /**
2792 * This parameter is not currently supported.
2793 */
2794 Filters?: FilterList;
2795 /**
2796 * 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.
2797 */
2798 MaxRecords?: IntegerOptional;
2799 /**
2800 * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
2801 */
2802 Marker?: String;
2803 }
2804 export interface DescribeEventsMessage {
2805 /**
2806 * The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. If the source type is DBInstance, then a DBInstanceIdentifier must be supplied. If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied. If the source type is DBParameterGroup, a DBParameterGroupName must be supplied. If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied. Cannot end with a hyphen or contain two consecutive hyphens.
2807 */
2808 SourceIdentifier?: String;
2809 /**
2810 * The event source to retrieve events for. If no value is specified, all events are returned.
2811 */
2812 SourceType?: SourceType;
2813 /**
2814 * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
2815 */
2816 StartTime?: TStamp;
2817 /**
2818 * The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
2819 */
2820 EndTime?: TStamp;
2821 /**
2822 * The number of minutes to retrieve events for. Default: 60
2823 */
2824 Duration?: IntegerOptional;
2825 /**
2826 * A list of event categories that trigger notifications for a event notification subscription.
2827 */
2828 EventCategories?: EventCategoriesList;
2829 /**
2830 * This parameter is not currently supported.
2831 */
2832 Filters?: FilterList;
2833 /**
2834 * 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.
2835 */
2836 MaxRecords?: IntegerOptional;
2837 /**
2838 * An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2839 */
2840 Marker?: String;
2841 }
2842 export interface DescribeOptionGroupOptionsMessage {
2843 /**
2844 * A required parameter. Options available for the given engine name will be described.
2845 */
2846 EngineName: String;
2847 /**
2848 * If specified, filters the results to include only options for the specified major engine version.
2849 */
2850 MajorEngineVersion?: String;
2851 /**
2852 * This parameter is not currently supported.
2853 */
2854 Filters?: FilterList;
2855 /**
2856 * 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.
2857 */
2858 MaxRecords?: IntegerOptional;
2859 /**
2860 * 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.
2861 */
2862 Marker?: String;
2863 }
2864 export interface DescribeOptionGroupsMessage {
2865 /**
2866 * The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
2867 */
2868 OptionGroupName?: String;
2869 /**
2870 * This parameter is not currently supported.
2871 */
2872 Filters?: FilterList;
2873 /**
2874 * An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2875 */
2876 Marker?: String;
2877 /**
2878 * 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.
2879 */
2880 MaxRecords?: IntegerOptional;
2881 /**
2882 * Filters the list of option groups to only include groups associated with a specific database engine.
2883 */
2884 EngineName?: String;
2885 /**
2886 * Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
2887 */
2888 MajorEngineVersion?: String;
2889 }
2890 export interface DescribeOrderableDBInstanceOptionsMessage {
2891 /**
2892 * The name of the engine to retrieve DB instance options for.
2893 */
2894 Engine: String;
2895 /**
2896 * The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
2897 */
2898 EngineVersion?: String;
2899 /**
2900 * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
2901 */
2902 DBInstanceClass?: String;
2903 /**
2904 * The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
2905 */
2906 LicenseModel?: String;
2907 /**
2908 * The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
2909 */
2910 Vpc?: BooleanOptional;
2911 /**
2912 * This parameter is not currently supported.
2913 */
2914 Filters?: FilterList;
2915 /**
2916 * 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.
2917 */
2918 MaxRecords?: IntegerOptional;
2919 /**
2920 * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
2921 */
2922 Marker?: String;
2923 }
2924 export interface DescribePendingMaintenanceActionsMessage {
2925 /**
2926 * The ARN of a resource to return pending maintenance actions for.
2927 */
2928 ResourceIdentifier?: String;
2929 /**
2930 * A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB instances identified by these ARNs.
2931 */
2932 Filters?: FilterList;
2933 /**
2934 * An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
2935 */
2936 Marker?: String;
2937 /**
2938 * 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.
2939 */
2940 MaxRecords?: IntegerOptional;
2941 }
2942 export interface DescribeReservedDBInstancesMessage {
2943 /**
2944 * The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
2945 */
2946 ReservedDBInstanceId?: String;
2947 /**
2948 * The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
2949 */
2950 ReservedDBInstancesOfferingId?: String;
2951 /**
2952 * The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
2953 */
2954 DBInstanceClass?: String;
2955 /**
2956 * The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
2957 */
2958 Duration?: String;
2959 /**
2960 * The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
2961 */
2962 ProductDescription?: String;
2963 /**
2964 * The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
2965 */
2966 OfferingType?: String;
2967 /**
2968 * The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
2969 */
2970 MultiAZ?: BooleanOptional;
2971 /**
2972 * This parameter is not currently supported.
2973 */
2974 Filters?: FilterList;
2975 /**
2976 * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
2977 */
2978 MaxRecords?: IntegerOptional;
2979 /**
2980 * 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.
2981 */
2982 Marker?: String;
2983 }
2984 export interface DescribeReservedDBInstancesOfferingsMessage {
2985 /**
2986 * The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
2987 */
2988 ReservedDBInstancesOfferingId?: String;
2989 /**
2990 * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
2991 */
2992 DBInstanceClass?: String;
2993 /**
2994 * Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
2995 */
2996 Duration?: String;
2997 /**
2998 * Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.
2999 */
3000 ProductDescription?: String;
3001 /**
3002 * The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
3003 */
3004 OfferingType?: String;
3005 /**
3006 * The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
3007 */
3008 MultiAZ?: BooleanOptional;
3009 /**
3010 * This parameter is not currently supported.
3011 */
3012 Filters?: FilterList;
3013 /**
3014 * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
3015 */
3016 MaxRecords?: IntegerOptional;
3017 /**
3018 * 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.
3019 */
3020 Marker?: String;
3021 }
3022 export interface DescribeSourceRegionsMessage {
3023 /**
3024 * The source region name. For example, us-east-1. Constraints: Must specify a valid AWS Region name.
3025 */
3026 RegionName?: String;
3027 /**
3028 * 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.
3029 */
3030 MaxRecords?: IntegerOptional;
3031 /**
3032 * An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
3033 */
3034 Marker?: String;
3035 /**
3036 * This parameter is not currently supported.
3037 */
3038 Filters?: FilterList;
3039 }
3040 export interface DomainMembership {
3041 /**
3042 * The identifier of the Active Directory Domain.
3043 */
3044 Domain?: String;
3045 /**
3046 * The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
3047 */
3048 Status?: String;
3049 /**
3050 * The fully qualified domain name of the Active Directory Domain.
3051 */
3052 FQDN?: String;
3053 /**
3054 * The name of the IAM role to be used when making API calls to the Directory Service.
3055 */
3056 IAMRoleName?: String;
3057 }
3058 export type DomainMembershipList = DomainMembership[];
3059 export type Double = number;
3060 export interface DownloadDBLogFilePortionDetails {
3061 /**
3062 * Entries from the specified log file.
3063 */
3064 LogFileData?: String;
3065 /**
3066 * A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
3067 */
3068 Marker?: String;
3069 /**
3070 * Boolean value that if true, indicates there is more data to be downloaded.
3071 */
3072 AdditionalDataPending?: Boolean;
3073 }
3074 export interface DownloadDBLogFilePortionMessage {
3075 /**
3076 * The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
3077 */
3078 DBInstanceIdentifier: String;
3079 /**
3080 * The name of the log file to be downloaded.
3081 */
3082 LogFileName: String;
3083 /**
3084 * The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
3085 */
3086 Marker?: String;
3087 /**
3088 * The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size. If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter. If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first. If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned. If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned. You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
3089 */
3090 NumberOfLines?: Integer;
3091 }
3092 export interface EC2SecurityGroup {
3093 /**
3094 * Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
3095 */
3096 Status?: String;
3097 /**
3098 * Specifies the name of the EC2 security group.
3099 */
3100 EC2SecurityGroupName?: String;
3101 /**
3102 * Specifies the id of the EC2 security group.
3103 */
3104 EC2SecurityGroupId?: String;
3105 /**
3106 * Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
3107 */
3108 EC2SecurityGroupOwnerId?: String;
3109 }
3110 export type EC2SecurityGroupList = EC2SecurityGroup[];
3111 export interface Endpoint {
3112 /**
3113 * Specifies the DNS address of the DB instance.
3114 */
3115 Address?: String;
3116 /**
3117 * Specifies the port that the database engine is listening on.
3118 */
3119 Port?: Integer;
3120 /**
3121 * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
3122 */
3123 HostedZoneId?: String;
3124 }
3125 export interface EngineDefaults {
3126 /**
3127 * Specifies the name of the DB parameter group family that the engine default parameters apply to.
3128 */
3129 DBParameterGroupFamily?: String;
3130 /**
3131 * An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
3132 */
3133 Marker?: String;
3134 /**
3135 * Contains a list of engine default parameters.
3136 */
3137 Parameters?: ParametersList;
3138 }
3139 export interface Event {
3140 /**
3141 * Provides the identifier for the source of the event.
3142 */
3143 SourceIdentifier?: String;
3144 /**
3145 * Specifies the source type for this event.
3146 */
3147 SourceType?: SourceType;
3148 /**
3149 * Provides the text of this event.
3150 */
3151 Message?: String;
3152 /**
3153 * Specifies the category for the event.
3154 */
3155 EventCategories?: EventCategoriesList;
3156 /**
3157 * Specifies the date and time of the event.
3158 */
3159 Date?: TStamp;
3160 /**
3161 * The Amazon Resource Name (ARN) for the event.
3162 */
3163 SourceArn?: String;
3164 }
3165 export type EventCategoriesList = String[];
3166 export interface EventCategoriesMap {
3167 /**
3168 * The source type that the returned categories belong to
3169 */
3170 SourceType?: String;
3171 /**
3172 * The event categories for the specified source type
3173 */
3174 EventCategories?: EventCategoriesList;
3175 }
3176 export type EventCategoriesMapList = EventCategoriesMap[];
3177 export interface EventCategoriesMessage {
3178 /**
3179 * A list of EventCategoriesMap data types.
3180 */
3181 EventCategoriesMapList?: EventCategoriesMapList;
3182 }
3183 export type EventList = Event[];
3184 export interface EventSubscription {
3185 /**
3186 * The AWS customer account associated with the RDS event notification subscription.
3187 */
3188 CustomerAwsId?: String;
3189 /**
3190 * The RDS event notification subscription Id.
3191 */
3192 CustSubscriptionId?: String;
3193 /**
3194 * The topic ARN of the RDS event notification subscription.
3195 */
3196 SnsTopicArn?: String;
3197 /**
3198 * The status of the RDS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
3199 */
3200 Status?: String;
3201 /**
3202 * The time the RDS event notification subscription was created.
3203 */
3204 SubscriptionCreationTime?: String;
3205 /**
3206 * The source type for the RDS event notification subscription.
3207 */
3208 SourceType?: String;
3209 /**
3210 * A list of source IDs for the RDS event notification subscription.
3211 */
3212 SourceIdsList?: SourceIdsList;
3213 /**
3214 * A list of event categories for the RDS event notification subscription.
3215 */
3216 EventCategoriesList?: EventCategoriesList;
3217 /**
3218 * A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
3219 */
3220 Enabled?: Boolean;
3221 /**
3222 * The Amazon Resource Name (ARN) for the event subscription.
3223 */
3224 EventSubscriptionArn?: String;
3225 }
3226 export type EventSubscriptionsList = EventSubscription[];
3227 export interface EventSubscriptionsMessage {
3228 /**
3229 * An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
3230 */
3231 Marker?: String;
3232 /**
3233 * A list of EventSubscriptions data types.
3234 */
3235 EventSubscriptionsList?: EventSubscriptionsList;
3236 }
3237 export interface EventsMessage {
3238 /**
3239 * An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
3240 */
3241 Marker?: String;
3242 /**
3243 * A list of Event instances.
3244 */
3245 Events?: EventList;
3246 }
3247 export interface FailoverDBClusterMessage {
3248 /**
3249 * A DB cluster identifier to force a failover for. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
3250 */
3251 DBClusterIdentifier?: String;
3252 /**
3253 * The name of the instance to promote to the primary instance. You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.
3254 */
3255 TargetDBInstanceIdentifier?: String;
3256 }
3257 export interface FailoverDBClusterResult {
3258 DBCluster?: DBCluster;
3259 }
3260 export interface Filter {
3261 /**
3262 * This parameter is not currently supported.
3263 */
3264 Name: String;
3265 /**
3266 * This parameter is not currently supported.
3267 */
3268 Values: FilterValueList;
3269 }
3270 export type FilterList = Filter[];
3271 export type FilterValueList = String[];
3272 export interface IPRange {
3273 /**
3274 * Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
3275 */
3276 Status?: String;
3277 /**
3278 * Specifies the IP range.
3279 */
3280 CIDRIP?: String;
3281 }
3282 export type IPRangeList = IPRange[];
3283 export type Integer = number;
3284 export type IntegerOptional = number;
3285 export type KeyList = String[];
3286 export interface ListTagsForResourceMessage {
3287 /**
3288 * The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
3289 */
3290 ResourceName: String;
3291 /**
3292 * This parameter is not currently supported.
3293 */
3294 Filters?: FilterList;
3295 }
3296 export type Long = number;
3297 export interface ModifyDBClusterMessage {
3298 /**
3299 * The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must be the identifier for an existing DB cluster. Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
3300 */
3301 DBClusterIdentifier: String;
3302 /**
3303 * The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-cluster2
3304 */
3305 NewDBClusterIdentifier?: String;
3306 /**
3307 * A value that 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 DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then 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
3308 */
3309 ApplyImmediately?: Boolean;
3310 /**
3311 * 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
3312 */
3313 BackupRetentionPeriod?: IntegerOptional;
3314 /**
3315 * The name of the DB cluster parameter group to use for the DB cluster.
3316 */
3317 DBClusterParameterGroupName?: String;
3318 /**
3319 * A lst of VPC security groups that the DB cluster will belong to.
3320 */
3321 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
3322 /**
3323 * The port number on which the DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster.
3324 */
3325 Port?: IntegerOptional;
3326 /**
3327 * The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
3328 */
3329 MasterUserPassword?: String;
3330 /**
3331 * A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.
3332 */
3333 OptionGroupName?: String;
3334 /**
3335 * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Times should be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
3336 */
3337 PreferredBackupWindow?: String;
3338 /**
3339 * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
3340 */
3341 PreferredMaintenanceWindow?: String;
3342 }
3343 export interface ModifyDBClusterParameterGroupMessage {
3344 /**
3345 * The name of the DB cluster parameter group to modify.
3346 */
3347 DBClusterParameterGroupName: String;
3348 /**
3349 * A list of parameters in the DB cluster parameter group to modify.
3350 */
3351 Parameters: ParametersList;
3352 }
3353 export interface ModifyDBClusterResult {
3354 DBCluster?: DBCluster;
3355 }
3356 export interface ModifyDBClusterSnapshotAttributeMessage {
3357 /**
3358 * The identifier for the DB cluster snapshot to modify the attributes for.
3359 */
3360 DBClusterSnapshotIdentifier: String;
3361 /**
3362 * The name of the DB cluster snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
3363 */
3364 AttributeName: String;
3365 /**
3366 * A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.
3367 */
3368 ValuesToAdd?: AttributeValueList;
3369 /**
3370 * A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
3371 */
3372 ValuesToRemove?: AttributeValueList;
3373 }
3374 export interface ModifyDBClusterSnapshotAttributeResult {
3375 DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
3376 }
3377 export interface ModifyDBInstanceMessage {
3378 /**
3379 * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must be the identifier for an existing DB instance Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
3380 */
3381 DBInstanceIdentifier: String;
3382 /**
3383 * The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request. MySQL Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer MariaDB Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer PostgreSQL Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer Oracle Default: Uses existing setting Valid Values: 10-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. SQL Server Cannot be modified. If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
3384 */
3385 AllocatedStorage?: IntegerOptional;
3386 /**
3387 * The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action. Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request. Default: Uses existing setting Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
3388 */
3389 DBInstanceClass?: String;
3390 /**
3391 * The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Example: mySubnetGroup
3392 */
3393 DBSubnetGroupName?: String;
3394 /**
3395 * A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
3396 */
3397 DBSecurityGroups?: DBSecurityGroupNameList;
3398 /**
3399 * A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
3400 */
3401 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
3402 /**
3403 * 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 DB instance. If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied. Default: false
3404 */
3405 ApplyImmediately?: Boolean;
3406 /**
3407 * The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@". Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Default: Uses existing setting Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
3408 */
3409 MasterUserPassword?: String;
3410 /**
3411 * The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
3412 */
3413 DBParameterGroupName?: String;
3414 /**
3415 * The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. Default: Uses existing setting Constraints: Must be a value from 0 to 35 Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5 Cannot be set to 0 if the DB instance is a source to Read Replicas
3416 */
3417 BackupRetentionPeriod?: IntegerOptional;
3418 /**
3419 * The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: Must be in the format hh24:mi-hh24:mi Times should be in Universal Time Coordinated (UTC) Must not conflict with the preferred maintenance window Must be at least 30 minutes
3420 */
3421 PreferredBackupWindow?: String;
3422 /**
3423 * The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not 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, then changing this parameter will cause a reboot of the DB instance. If 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 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
3424 */
3425 PreferredMaintenanceWindow?: String;
3426 /**
3427 * Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. Constraints: Cannot be specified if the DB instance is a Read Replica.
3428 */
3429 MultiAZ?: BooleanOptional;
3430 /**
3431 * The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. For a list of valid engine versions, see CreateDBInstance.
3432 */
3433 EngineVersion?: String;
3434 /**
3435 * Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
3436 */
3437 AllowMajorVersionUpgrade?: Boolean;
3438 /**
3439 * Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
3440 */
3441 AutoMinorVersionUpgrade?: BooleanOptional;
3442 /**
3443 * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
3444 */
3445 LicenseModel?: String;
3446 /**
3447 * The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. Default: Uses existing setting Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect. SQL Server Setting the IOPS value for the SQL Server database engine is not supported. Type: Integer If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
3448 */
3449 Iops?: IntegerOptional;
3450 /**
3451 * Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
3452 */
3453 OptionGroupName?: String;
3454 /**
3455 * The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
3456 */
3457 NewDBInstanceIdentifier?: String;
3458 /**
3459 * Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard
3460 */
3461 StorageType?: String;
3462 /**
3463 * The ARN from the Key Store with which to associate the instance for TDE encryption.
3464 */
3465 TdeCredentialArn?: String;
3466 /**
3467 * The password for the given ARN from the Key Store in order to access the device.
3468 */
3469 TdeCredentialPassword?: String;
3470 /**
3471 * Indicates the certificate that needs to be associated with the instance.
3472 */
3473 CACertificateIdentifier?: String;
3474 /**
3475 * The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain.
3476 */
3477 Domain?: String;
3478 /**
3479 * True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
3480 */
3481 CopyTagsToSnapshot?: BooleanOptional;
3482 /**
3483 * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
3484 */
3485 MonitoringInterval?: IntegerOptional;
3486 /**
3487 * The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter. MySQL Default: 3306 Valid Values: 1150-65535 MariaDB Default: 3306 Valid Values: 1150-65535 PostgreSQL Default: 5432 Valid Values: 1150-65535 Type: Integer Oracle Default: 1521 Valid Values: 1150-65535 SQL Server Default: 1433 Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156. Amazon Aurora Default: 3306 Valid Values: 1150-65535
3488 */
3489 DBPortNumber?: IntegerOptional;
3490 /**
3491 * Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address. PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter. Default: false
3492 */
3493 PubliclyAccessible?: BooleanOptional;
3494 /**
3495 * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
3496 */
3497 MonitoringRoleArn?: String;
3498 /**
3499 * The name of the IAM role to use when making API calls to the Directory Service.
3500 */
3501 DomainIAMRoleName?: String;
3502 /**
3503 * A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster. Default: 1 Valid Values: 0 - 15
3504 */
3505 PromotionTier?: IntegerOptional;
3506 }
3507 export interface ModifyDBInstanceResult {
3508 DBInstance?: DBInstance;
3509 }
3510 export interface ModifyDBParameterGroupMessage {
3511 /**
3512 * The name of the DB parameter group. Constraints: Must be the name of an existing DB parameter group Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
3513 */
3514 DBParameterGroupName: String;
3515 /**
3516 * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
3517 */
3518 Parameters: ParametersList;
3519 }
3520 export interface ModifyDBSnapshotAttributeMessage {
3521 /**
3522 * The identifier for the DB snapshot to modify the attributes for.
3523 */
3524 DBSnapshotIdentifier: String;
3525 /**
3526 * The name of the DB snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore.
3527 */
3528 AttributeName: String;
3529 /**
3530 * A list of DB snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.
3531 */
3532 ValuesToAdd?: AttributeValueList;
3533 /**
3534 * A list of DB snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.
3535 */
3536 ValuesToRemove?: AttributeValueList;
3537 }
3538 export interface ModifyDBSnapshotAttributeResult {
3539 DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
3540 }
3541 export interface ModifyDBSubnetGroupMessage {
3542 /**
3543 * The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
3544 */
3545 DBSubnetGroupName: String;
3546 /**
3547 * The description for the DB subnet group.
3548 */
3549 DBSubnetGroupDescription?: String;
3550 /**
3551 * The EC2 subnet IDs for the DB subnet group.
3552 */
3553 SubnetIds: SubnetIdentifierList;
3554 }
3555 export interface ModifyDBSubnetGroupResult {
3556 DBSubnetGroup?: DBSubnetGroup;
3557 }
3558 export interface ModifyEventSubscriptionMessage {
3559 /**
3560 * The name of the RDS event notification subscription.
3561 */
3562 SubscriptionName: String;
3563 /**
3564 * 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.
3565 */
3566 SnsTopicArn?: String;
3567 /**
3568 * The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
3569 */
3570 SourceType?: String;
3571 /**
3572 * A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
3573 */
3574 EventCategories?: EventCategoriesList;
3575 /**
3576 * A Boolean value; set to true to activate the subscription.
3577 */
3578 Enabled?: BooleanOptional;
3579 }
3580 export interface ModifyEventSubscriptionResult {
3581 EventSubscription?: EventSubscription;
3582 }
3583 export interface ModifyOptionGroupMessage {
3584 /**
3585 * The name of the option group to be modified. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
3586 */
3587 OptionGroupName: String;
3588 /**
3589 * Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
3590 */
3591 OptionsToInclude?: OptionConfigurationList;
3592 /**
3593 * Options in this list are removed from the option group.
3594 */
3595 OptionsToRemove?: OptionNamesList;
3596 /**
3597 * Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.
3598 */
3599 ApplyImmediately?: Boolean;
3600 }
3601 export interface ModifyOptionGroupResult {
3602 OptionGroup?: OptionGroup;
3603 }
3604 export interface Option {
3605 /**
3606 * The name of the option.
3607 */
3608 OptionName?: String;
3609 /**
3610 * The description of the option.
3611 */
3612 OptionDescription?: String;
3613 /**
3614 * Indicate if this option is persistent.
3615 */
3616 Persistent?: Boolean;
3617 /**
3618 * Indicate if this option is permanent.
3619 */
3620 Permanent?: Boolean;
3621 /**
3622 * If required, the port configured for this option to use.
3623 */
3624 Port?: IntegerOptional;
3625 /**
3626 * The version of the option.
3627 */
3628 OptionVersion?: String;
3629 /**
3630 * The option settings for this option.
3631 */
3632 OptionSettings?: OptionSettingConfigurationList;
3633 /**
3634 * If the option requires access to a port, then this DB security group allows access to the port.
3635 */
3636 DBSecurityGroupMemberships?: DBSecurityGroupMembershipList;
3637 /**
3638 * If the option requires access to a port, then this VPC security group allows access to the port.
3639 */
3640 VpcSecurityGroupMemberships?: VpcSecurityGroupMembershipList;
3641 }
3642 export interface OptionConfiguration {
3643 /**
3644 * The configuration of options to include in a group.
3645 */
3646 OptionName: String;
3647 /**
3648 * The optional port for the option.
3649 */
3650 Port?: IntegerOptional;
3651 /**
3652 * The version for the option.
3653 */
3654 OptionVersion?: String;
3655 /**
3656 * A list of DBSecurityGroupMemebrship name strings used for this option.
3657 */
3658 DBSecurityGroupMemberships?: DBSecurityGroupNameList;
3659 /**
3660 * A list of VpcSecurityGroupMemebrship name strings used for this option.
3661 */
3662 VpcSecurityGroupMemberships?: VpcSecurityGroupIdList;
3663 /**
3664 * The option settings to include in an option group.
3665 */
3666 OptionSettings?: OptionSettingsList;
3667 }
3668 export type OptionConfigurationList = OptionConfiguration[];
3669 export interface OptionGroup {
3670 /**
3671 * Specifies the name of the option group.
3672 */
3673 OptionGroupName?: String;
3674 /**
3675 * Provides a description of the option group.
3676 */
3677 OptionGroupDescription?: String;
3678 /**
3679 * Indicates the name of the engine that this option group can be applied to.
3680 */
3681 EngineName?: String;
3682 /**
3683 * Indicates the major engine version associated with this option group.
3684 */
3685 MajorEngineVersion?: String;
3686 /**
3687 * Indicates what options are available in the option group.
3688 */
3689 Options?: OptionsList;
3690 /**
3691 * Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
3692 */
3693 AllowsVpcAndNonVpcInstanceMemberships?: Boolean;
3694 /**
3695 * If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
3696 */
3697 VpcId?: String;
3698 /**
3699 * The Amazon Resource Name (ARN) for the option group.
3700 */
3701 OptionGroupArn?: String;
3702 }
3703 export interface OptionGroupMembership {
3704 /**
3705 * The name of the option group that the instance belongs to.
3706 */
3707 OptionGroupName?: String;
3708 /**
3709 * The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.
3710 */
3711 Status?: String;
3712 }
3713 export type OptionGroupMembershipList = OptionGroupMembership[];
3714 export interface OptionGroupOption {
3715 /**
3716 * The name of the option.
3717 */
3718 Name?: String;
3719 /**
3720 * The description of the option.
3721 */
3722 Description?: String;
3723 /**
3724 * The name of the engine that this option can be applied to.
3725 */
3726 EngineName?: String;
3727 /**
3728 * Indicates the major engine version that the option is available for.
3729 */
3730 MajorEngineVersion?: String;
3731 /**
3732 * The minimum required engine version for the option to be applied.
3733 */
3734 MinimumRequiredMinorEngineVersion?: String;
3735 /**
3736 * Specifies whether the option requires a port.
3737 */
3738 PortRequired?: Boolean;
3739 /**
3740 * If the option requires a port, specifies the default port for the option.
3741 */
3742 DefaultPort?: IntegerOptional;
3743 /**
3744 * The options that are prerequisites for this option.
3745 */
3746 OptionsDependedOn?: OptionsDependedOn;
3747 /**
3748 * The options that conflict with this option.
3749 */
3750 OptionsConflictsWith?: OptionsConflictsWith;
3751 /**
3752 * Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
3753 */
3754 Persistent?: Boolean;
3755 /**
3756 * Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
3757 */
3758 Permanent?: Boolean;
3759 /**
3760 * The option settings that are available (and the default value) for each option in an option group.
3761 */
3762 OptionGroupOptionSettings?: OptionGroupOptionSettingsList;
3763 /**
3764 * The versions that are available for the option.
3765 */
3766 OptionGroupOptionVersions?: OptionGroupOptionVersionsList;
3767 }
3768 export interface OptionGroupOptionSetting {
3769 /**
3770 * The name of the option group option.
3771 */
3772 SettingName?: String;
3773 /**
3774 * The description of the option group option.
3775 */
3776 SettingDescription?: String;
3777 /**
3778 * The default value for the option group option.
3779 */
3780 DefaultValue?: String;
3781 /**
3782 * The DB engine specific parameter type for the option group option.
3783 */
3784 ApplyType?: String;
3785 /**
3786 * Indicates the acceptable values for the option group option.
3787 */
3788 AllowedValues?: String;
3789 /**
3790 * Boolean value where true indicates that this option group option can be changed from the default value.
3791 */
3792 IsModifiable?: Boolean;
3793 }
3794 export type OptionGroupOptionSettingsList = OptionGroupOptionSetting[];
3795 export type OptionGroupOptionVersionsList = OptionVersion[];
3796 export type OptionGroupOptionsList = OptionGroupOption[];
3797 export interface OptionGroupOptionsMessage {
3798 OptionGroupOptions?: OptionGroupOptionsList;
3799 /**
3800 * 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.
3801 */
3802 Marker?: String;
3803 }
3804 export interface OptionGroups {
3805 /**
3806 * List of option groups.
3807 */
3808 OptionGroupsList?: OptionGroupsList;
3809 /**
3810 * 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.
3811 */
3812 Marker?: String;
3813 }
3814 export type OptionGroupsList = OptionGroup[];
3815 export type OptionNamesList = String[];
3816 export interface OptionSetting {
3817 /**
3818 * The name of the option that has settings that you can set.
3819 */
3820 Name?: String;
3821 /**
3822 * The current value of the option setting.
3823 */
3824 Value?: String;
3825 /**
3826 * The default value of the option setting.
3827 */
3828 DefaultValue?: String;
3829 /**
3830 * The description of the option setting.
3831 */
3832 Description?: String;
3833 /**
3834 * The DB engine specific parameter type.
3835 */
3836 ApplyType?: String;
3837 /**
3838 * The data type of the option setting.
3839 */
3840 DataType?: String;
3841 /**
3842 * The allowed values of the option setting.
3843 */
3844 AllowedValues?: String;
3845 /**
3846 * A Boolean value that, when true, indicates the option setting can be modified from the default.
3847 */
3848 IsModifiable?: Boolean;
3849 /**
3850 * Indicates if the option setting is part of a collection.
3851 */
3852 IsCollection?: Boolean;
3853 }
3854 export type OptionSettingConfigurationList = OptionSetting[];
3855 export type OptionSettingsList = OptionSetting[];
3856 export interface OptionVersion {
3857 /**
3858 * The version of the option.
3859 */
3860 Version?: String;
3861 /**
3862 * True if the version is the default version of the option; otherwise, false.
3863 */
3864 IsDefault?: Boolean;
3865 }
3866 export type OptionsConflictsWith = String[];
3867 export type OptionsDependedOn = String[];
3868 export type OptionsList = Option[];
3869 export interface OrderableDBInstanceOption {
3870 /**
3871 * The engine type of the orderable DB instance.
3872 */
3873 Engine?: String;
3874 /**
3875 * The engine version of the orderable DB instance.
3876 */
3877 EngineVersion?: String;
3878 /**
3879 * The DB instance class for the orderable DB instance.
3880 */
3881 DBInstanceClass?: String;
3882 /**
3883 * The license model for the orderable DB instance.
3884 */
3885 LicenseModel?: String;
3886 /**
3887 * A list of Availability Zones for the orderable DB instance.
3888 */
3889 AvailabilityZones?: AvailabilityZoneList;
3890 /**
3891 * Indicates whether this orderable DB instance is multi-AZ capable.
3892 */
3893 MultiAZCapable?: Boolean;
3894 /**
3895 * Indicates whether this orderable DB instance can have a Read Replica.
3896 */
3897 ReadReplicaCapable?: Boolean;
3898 /**
3899 * Indicates whether this is a VPC orderable DB instance.
3900 */
3901 Vpc?: Boolean;
3902 /**
3903 * Indicates whether this orderable DB instance supports encrypted storage.
3904 */
3905 SupportsStorageEncryption?: Boolean;
3906 /**
3907 * Indicates the storage type for this orderable DB instance.
3908 */
3909 StorageType?: String;
3910 /**
3911 * Indicates whether this orderable DB instance supports provisioned IOPS.
3912 */
3913 SupportsIops?: Boolean;
3914 /**
3915 * Indicates whether the DB instance supports enhanced monitoring at intervals from 1 to 60 seconds.
3916 */
3917 SupportsEnhancedMonitoring?: Boolean;
3918 }
3919 export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[];
3920 export interface OrderableDBInstanceOptionsMessage {
3921 /**
3922 * An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
3923 */
3924 OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList;
3925 /**
3926 * An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
3927 */
3928 Marker?: String;
3929 }
3930 export interface Parameter {
3931 /**
3932 * Specifies the name of the parameter.
3933 */
3934 ParameterName?: String;
3935 /**
3936 * Specifies the value of the parameter.
3937 */
3938 ParameterValue?: String;
3939 /**
3940 * Provides a description of the parameter.
3941 */
3942 Description?: String;
3943 /**
3944 * Indicates the source of the parameter value.
3945 */
3946 Source?: String;
3947 /**
3948 * Specifies the engine specific parameters type.
3949 */
3950 ApplyType?: String;
3951 /**
3952 * Specifies the valid data type for the parameter.
3953 */
3954 DataType?: String;
3955 /**
3956 * Specifies the valid range of values for the parameter.
3957 */
3958 AllowedValues?: String;
3959 /**
3960 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
3961 */
3962 IsModifiable?: Boolean;
3963 /**
3964 * The earliest engine version to which the parameter can apply.
3965 */
3966 MinimumEngineVersion?: String;
3967 /**
3968 * Indicates when to apply parameter updates.
3969 */
3970 ApplyMethod?: ApplyMethod;
3971 }
3972 export type ParametersList = Parameter[];
3973 export interface PendingMaintenanceAction {
3974 /**
3975 * The type of pending maintenance action that is available for the resource.
3976 */
3977 Action?: String;
3978 /**
3979 * The date of the maintenance window when the action will be applied. The maintenance action will be 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.
3980 */
3981 AutoAppliedAfterDate?: TStamp;
3982 /**
3983 * The date when the maintenance action will be automatically applied. The maintenance action will be 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.
3984 */
3985 ForcedApplyDate?: TStamp;
3986 /**
3987 * Indicates the type of opt-in request that has been received for the resource.
3988 */
3989 OptInStatus?: String;
3990 /**
3991 * The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
3992 */
3993 CurrentApplyDate?: TStamp;
3994 /**
3995 * A description providing more detail about the maintenance action.
3996 */
3997 Description?: String;
3998 }
3999 export type PendingMaintenanceActionDetails = PendingMaintenanceAction[];
4000 export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[];
4001 export interface PendingMaintenanceActionsMessage {
4002 /**
4003 * A list of the pending maintenance actions for the resource.
4004 */
4005 PendingMaintenanceActions?: PendingMaintenanceActions;
4006 /**
4007 * An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
4008 */
4009 Marker?: String;
4010 }
4011 export interface PendingModifiedValues {
4012 /**
4013 * Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.
4014 */
4015 DBInstanceClass?: String;
4016 /**
4017 * Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.
4018 */
4019 AllocatedStorage?: IntegerOptional;
4020 /**
4021 * Contains the pending or in-progress change of the master credentials for the DB instance.
4022 */
4023 MasterUserPassword?: String;
4024 /**
4025 * Specifies the pending port for the DB instance.
4026 */
4027 Port?: IntegerOptional;
4028 /**
4029 * Specifies the pending number of days for which automated backups are retained.
4030 */
4031 BackupRetentionPeriod?: IntegerOptional;
4032 /**
4033 * Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
4034 */
4035 MultiAZ?: BooleanOptional;
4036 /**
4037 * Indicates the database engine version.
4038 */
4039 EngineVersion?: String;
4040 /**
4041 * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
4042 */
4043 LicenseModel?: String;
4044 /**
4045 * Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.
4046 */
4047 Iops?: IntegerOptional;
4048 /**
4049 * Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.
4050 */
4051 DBInstanceIdentifier?: String;
4052 /**
4053 * Specifies the storage type to be associated with the DB instance.
4054 */
4055 StorageType?: String;
4056 /**
4057 * Specifies the identifier of the CA certificate for the DB instance.
4058 */
4059 CACertificateIdentifier?: String;
4060 /**
4061 * The new DB subnet group for the DB instance.
4062 */
4063 DBSubnetGroupName?: String;
4064 }
4065 export interface PromoteReadReplicaDBClusterMessage {
4066 /**
4067 * The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-replica1
4068 */
4069 DBClusterIdentifier: String;
4070 }
4071 export interface PromoteReadReplicaDBClusterResult {
4072 DBCluster?: DBCluster;
4073 }
4074 export interface PromoteReadReplicaMessage {
4075 /**
4076 * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must be the identifier for an existing Read Replica DB instance Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: mydbinstance
4077 */
4078 DBInstanceIdentifier: String;
4079 /**
4080 * The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: Must be a value from 0 to 8
4081 */
4082 BackupRetentionPeriod?: IntegerOptional;
4083 /**
4084 * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Times should be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
4085 */
4086 PreferredBackupWindow?: String;
4087 }
4088 export interface PromoteReadReplicaResult {
4089 DBInstance?: DBInstance;
4090 }
4091 export interface PurchaseReservedDBInstancesOfferingMessage {
4092 /**
4093 * The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
4094 */
4095 ReservedDBInstancesOfferingId: String;
4096 /**
4097 * Customer-specified identifier to track this reservation. Example: myreservationID
4098 */
4099 ReservedDBInstanceId?: String;
4100 /**
4101 * The number of instances to reserve. Default: 1
4102 */
4103 DBInstanceCount?: IntegerOptional;
4104 Tags?: TagList;
4105 }
4106 export interface PurchaseReservedDBInstancesOfferingResult {
4107 ReservedDBInstance?: ReservedDBInstance;
4108 }
4109 export type ReadReplicaDBInstanceIdentifierList = String[];
4110 export type ReadReplicaIdentifierList = String[];
4111 export interface RebootDBInstanceMessage {
4112 /**
4113 * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
4114 */
4115 DBInstanceIdentifier: String;
4116 /**
4117 * When true, the reboot will be conducted through a MultiAZ failover. Constraint: You cannot specify true if the instance is not configured for MultiAZ.
4118 */
4119 ForceFailover?: BooleanOptional;
4120 }
4121 export interface RebootDBInstanceResult {
4122 DBInstance?: DBInstance;
4123 }
4124 export interface RecurringCharge {
4125 /**
4126 * The amount of the recurring charge.
4127 */
4128 RecurringChargeAmount?: Double;
4129 /**
4130 * The frequency of the recurring charge.
4131 */
4132 RecurringChargeFrequency?: String;
4133 }
4134 export type RecurringChargeList = RecurringCharge[];
4135 export interface RemoveRoleFromDBClusterMessage {
4136 /**
4137 * The name of the DB cluster to disassociate the IAM role rom.
4138 */
4139 DBClusterIdentifier: String;
4140 /**
4141 * The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
4142 */
4143 RoleArn: String;
4144 }
4145 export interface RemoveSourceIdentifierFromSubscriptionMessage {
4146 /**
4147 * The name of the RDS event notification subscription you want to remove a source identifier from.
4148 */
4149 SubscriptionName: String;
4150 /**
4151 * The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
4152 */
4153 SourceIdentifier: String;
4154 }
4155 export interface RemoveSourceIdentifierFromSubscriptionResult {
4156 EventSubscription?: EventSubscription;
4157 }
4158 export interface RemoveTagsFromResourceMessage {
4159 /**
4160 * The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
4161 */
4162 ResourceName: String;
4163 /**
4164 * The tag key (name) of the tag to be removed.
4165 */
4166 TagKeys: KeyList;
4167 }
4168 export interface ReservedDBInstance {
4169 /**
4170 * The unique identifier for the reservation.
4171 */
4172 ReservedDBInstanceId?: String;
4173 /**
4174 * The offering identifier.
4175 */
4176 ReservedDBInstancesOfferingId?: String;
4177 /**
4178 * The DB instance class for the reserved DB instance.
4179 */
4180 DBInstanceClass?: String;
4181 /**
4182 * The time the reservation started.
4183 */
4184 StartTime?: TStamp;
4185 /**
4186 * The duration of the reservation in seconds.
4187 */
4188 Duration?: Integer;
4189 /**
4190 * The fixed price charged for this reserved DB instance.
4191 */
4192 FixedPrice?: Double;
4193 /**
4194 * The hourly price charged for this reserved DB instance.
4195 */
4196 UsagePrice?: Double;
4197 /**
4198 * The currency code for the reserved DB instance.
4199 */
4200 CurrencyCode?: String;
4201 /**
4202 * The number of reserved DB instances.
4203 */
4204 DBInstanceCount?: Integer;
4205 /**
4206 * The description of the reserved DB instance.
4207 */
4208 ProductDescription?: String;
4209 /**
4210 * The offering type of this reserved DB instance.
4211 */
4212 OfferingType?: String;
4213 /**
4214 * Indicates if the reservation applies to Multi-AZ deployments.
4215 */
4216 MultiAZ?: Boolean;
4217 /**
4218 * The state of the reserved DB instance.
4219 */
4220 State?: String;
4221 /**
4222 * The recurring price charged to run this reserved DB instance.
4223 */
4224 RecurringCharges?: RecurringChargeList;
4225 /**
4226 * The Amazon Resource Name (ARN) for the reserved DB instance.
4227 */
4228 ReservedDBInstanceArn?: String;
4229 }
4230 export type ReservedDBInstanceList = ReservedDBInstance[];
4231 export interface ReservedDBInstanceMessage {
4232 /**
4233 * 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.
4234 */
4235 Marker?: String;
4236 /**
4237 * A list of reserved DB instances.
4238 */
4239 ReservedDBInstances?: ReservedDBInstanceList;
4240 }
4241 export interface ReservedDBInstancesOffering {
4242 /**
4243 * The offering identifier.
4244 */
4245 ReservedDBInstancesOfferingId?: String;
4246 /**
4247 * The DB instance class for the reserved DB instance.
4248 */
4249 DBInstanceClass?: String;
4250 /**
4251 * The duration of the offering in seconds.
4252 */
4253 Duration?: Integer;
4254 /**
4255 * The fixed price charged for this offering.
4256 */
4257 FixedPrice?: Double;
4258 /**
4259 * The hourly price charged for this offering.
4260 */
4261 UsagePrice?: Double;
4262 /**
4263 * The currency code for the reserved DB instance offering.
4264 */
4265 CurrencyCode?: String;
4266 /**
4267 * The database engine used by the offering.
4268 */
4269 ProductDescription?: String;
4270 /**
4271 * The offering type.
4272 */
4273 OfferingType?: String;
4274 /**
4275 * Indicates if the offering applies to Multi-AZ deployments.
4276 */
4277 MultiAZ?: Boolean;
4278 /**
4279 * The recurring price charged to run this reserved DB instance.
4280 */
4281 RecurringCharges?: RecurringChargeList;
4282 }
4283 export type ReservedDBInstancesOfferingList = ReservedDBInstancesOffering[];
4284 export interface ReservedDBInstancesOfferingMessage {
4285 /**
4286 * 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.
4287 */
4288 Marker?: String;
4289 /**
4290 * A list of reserved DB instance offerings.
4291 */
4292 ReservedDBInstancesOfferings?: ReservedDBInstancesOfferingList;
4293 }
4294 export interface ResetDBClusterParameterGroupMessage {
4295 /**
4296 * The name of the DB cluster parameter group to reset.
4297 */
4298 DBClusterParameterGroupName: String;
4299 /**
4300 * A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.
4301 */
4302 ResetAllParameters?: Boolean;
4303 /**
4304 * A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.
4305 */
4306 Parameters?: ParametersList;
4307 }
4308 export interface ResetDBParameterGroupMessage {
4309 /**
4310 * The name of the DB parameter group. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
4311 */
4312 DBParameterGroupName: String;
4313 /**
4314 * Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values. Default: true
4315 */
4316 ResetAllParameters?: Boolean;
4317 /**
4318 * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. MySQL Valid Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots. MariaDB Valid Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots. Oracle Valid Values (for Apply method): pending-reboot
4319 */
4320 Parameters?: ParametersList;
4321 }
4322 export interface ResourcePendingMaintenanceActions {
4323 /**
4324 * The ARN of the resource that has pending maintenance actions.
4325 */
4326 ResourceIdentifier?: String;
4327 /**
4328 * A list that provides details about the pending maintenance actions for the resource.
4329 */
4330 PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails;
4331 }
4332 export interface RestoreDBClusterFromS3Message {
4333 /**
4334 * A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
4335 */
4336 AvailabilityZones?: AvailabilityZones;
4337 /**
4338 * The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35
4339 */
4340 BackupRetentionPeriod?: IntegerOptional;
4341 /**
4342 * A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
4343 */
4344 CharacterSetName?: String;
4345 /**
4346 * The database name for the restored DB cluster.
4347 */
4348 DatabaseName?: String;
4349 /**
4350 * The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
4351 */
4352 DBClusterIdentifier: String;
4353 /**
4354 * The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 will be used. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
4355 */
4356 DBClusterParameterGroupName?: String;
4357 /**
4358 * A list of EC2 VPC security groups to associate with the restored DB cluster.
4359 */
4360 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
4361 /**
4362 * A DB subnet group to associate with the restored DB cluster. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
4363 */
4364 DBSubnetGroupName?: String;
4365 /**
4366 * The name of the database engine to be used for the restored DB cluster. Valid Values: aurora
4367 */
4368 Engine: String;
4369 /**
4370 * The version number of the database engine to use. Aurora Example: 5.6.10a
4371 */
4372 EngineVersion?: String;
4373 /**
4374 * The port number on which the instances in the restored DB cluster accept connections. Default: 3306
4375 */
4376 Port?: IntegerOptional;
4377 /**
4378 * The name of the master user for the restored DB cluster. Constraints: Must be 1 to 16 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine.
4379 */
4380 MasterUsername: String;
4381 /**
4382 * The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
4383 */
4384 MasterUserPassword: String;
4385 /**
4386 * A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.
4387 */
4388 OptionGroupName?: String;
4389 /**
4390 * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Times should be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
4391 */
4392 PreferredBackupWindow?: String;
4393 /**
4394 * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
4395 */
4396 PreferredMaintenanceWindow?: String;
4397 Tags?: TagList;
4398 /**
4399 * Specifies whether the restored DB cluster is encrypted.
4400 */
4401 StorageEncrypted?: BooleanOptional;
4402 /**
4403 * The KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
4404 */
4405 KmsKeyId?: String;
4406 /**
4407 * The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: mysql
4408 */
4409 SourceEngine: String;
4410 /**
4411 * The version of the database that the backup files were created from. MySQL version 5.5 and 5.6 are supported. Example: 5.6.22
4412 */
4413 SourceEngineVersion: String;
4414 /**
4415 * The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
4416 */
4417 S3BucketName: String;
4418 /**
4419 * The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
4420 */
4421 S3Prefix?: String;
4422 /**
4423 * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
4424 */
4425 S3IngestionRoleArn: String;
4426 }
4427 export interface RestoreDBClusterFromS3Result {
4428 DBCluster?: DBCluster;
4429 }
4430 export interface RestoreDBClusterFromSnapshotMessage {
4431 /**
4432 * Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
4433 */
4434 AvailabilityZones?: AvailabilityZones;
4435 /**
4436 * The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
4437 */
4438 DBClusterIdentifier: String;
4439 /**
4440 * The identifier for the DB cluster snapshot to restore from. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
4441 */
4442 SnapshotIdentifier: String;
4443 /**
4444 * The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source
4445 */
4446 Engine: String;
4447 /**
4448 * The version of the database engine to use for the new DB cluster.
4449 */
4450 EngineVersion?: String;
4451 /**
4452 * The port number on which the new DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster.
4453 */
4454 Port?: IntegerOptional;
4455 /**
4456 * The name of the DB subnet group to use for the new DB cluster. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
4457 */
4458 DBSubnetGroupName?: String;
4459 /**
4460 * The database name for the restored DB cluster.
4461 */
4462 DatabaseName?: String;
4463 /**
4464 * The name of the option group to use for the restored DB cluster.
4465 */
4466 OptionGroupName?: String;
4467 /**
4468 * A list of VPC security groups that the new DB cluster will belong to.
4469 */
4470 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
4471 /**
4472 * The tags to be assigned to the restored DB cluster.
4473 */
4474 Tags?: TagList;
4475 /**
4476 * The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB 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 will occur: If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot. If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.
4477 */
4478 KmsKeyId?: String;
4479 }
4480 export interface RestoreDBClusterFromSnapshotResult {
4481 DBCluster?: DBCluster;
4482 }
4483 export interface RestoreDBClusterToPointInTimeMessage {
4484 /**
4485 * The name of the new DB cluster to be created. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
4486 */
4487 DBClusterIdentifier: String;
4488 /**
4489 * The identifier of the source DB cluster from which to restore. Constraints: Must be the identifier of an existing database instance Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
4490 */
4491 SourceDBClusterIdentifier: String;
4492 /**
4493 * The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Cannot be specified if UseLatestRestorableTime parameter is true Example: 2015-03-07T23:45:00Z
4494 */
4495 RestoreToTime?: TStamp;
4496 /**
4497 * A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be specified if RestoreToTime parameter is provided.
4498 */
4499 UseLatestRestorableTime?: Boolean;
4500 /**
4501 * The port number on which the new DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster.
4502 */
4503 Port?: IntegerOptional;
4504 /**
4505 * The DB subnet group name to use for the new DB cluster. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
4506 */
4507 DBSubnetGroupName?: String;
4508 /**
4509 * The name of the option group for the new DB cluster.
4510 */
4511 OptionGroupName?: String;
4512 /**
4513 * A lst of VPC security groups that the new DB cluster belongs to.
4514 */
4515 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
4516 Tags?: TagList;
4517 /**
4518 * The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter. If you do not specify a value for the KmsKeyId parameter, then the following will occur: If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. If the DB cluster is not encrypted, then the restored DB cluster is not encrypted. If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.
4519 */
4520 KmsKeyId?: String;
4521 }
4522 export interface RestoreDBClusterToPointInTimeResult {
4523 DBCluster?: DBCluster;
4524 }
4525 export interface RestoreDBInstanceFromDBSnapshotMessage {
4526 /**
4527 * Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server) First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
4528 */
4529 DBInstanceIdentifier: String;
4530 /**
4531 * The identifier for the DB snapshot to restore from. Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
4532 */
4533 DBSnapshotIdentifier: String;
4534 /**
4535 * The compute and memory capacity of the Amazon RDS DB instance. Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
4536 */
4537 DBInstanceClass?: String;
4538 /**
4539 * The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be 1150-65535
4540 */
4541 Port?: IntegerOptional;
4542 /**
4543 * The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a
4544 */
4545 AvailabilityZone?: String;
4546 /**
4547 * The DB subnet group name to use for the new instance. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
4548 */
4549 DBSubnetGroupName?: String;
4550 /**
4551 * Specifies if the DB instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
4552 */
4553 MultiAZ?: BooleanOptional;
4554 /**
4555 * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. Default VPC: true VPC: false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
4556 */
4557 PubliclyAccessible?: BooleanOptional;
4558 /**
4559 * Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
4560 */
4561 AutoMinorVersionUpgrade?: BooleanOptional;
4562 /**
4563 * License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
4564 */
4565 LicenseModel?: String;
4566 /**
4567 * The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
4568 */
4569 DBName?: String;
4570 /**
4571 * The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora
4572 */
4573 Engine?: String;
4574 /**
4575 * Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts. Constraints: Must be an integer greater than 1000. SQL Server Setting the IOPS value for the SQL Server database engine is not supported.
4576 */
4577 Iops?: IntegerOptional;
4578 /**
4579 * The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
4580 */
4581 OptionGroupName?: String;
4582 Tags?: TagList;
4583 /**
4584 * Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard
4585 */
4586 StorageType?: String;
4587 /**
4588 * The ARN from the Key Store with which to associate the instance for TDE encryption.
4589 */
4590 TdeCredentialArn?: String;
4591 /**
4592 * The password for the given ARN from the Key Store in order to access the device.
4593 */
4594 TdeCredentialPassword?: String;
4595 /**
4596 * Specify the Active Directory Domain to restore the instance in.
4597 */
4598 Domain?: String;
4599 /**
4600 * True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
4601 */
4602 CopyTagsToSnapshot?: BooleanOptional;
4603 /**
4604 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
4605 */
4606 DomainIAMRoleName?: String;
4607 }
4608 export interface RestoreDBInstanceFromDBSnapshotResult {
4609 DBInstance?: DBInstance;
4610 }
4611 export interface RestoreDBInstanceToPointInTimeMessage {
4612 /**
4613 * The identifier of the source DB instance from which to restore. Constraints: Must be the identifier of an existing database instance Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
4614 */
4615 SourceDBInstanceIdentifier: String;
4616 /**
4617 * The name of the new database instance to be created. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
4618 */
4619 TargetDBInstanceIdentifier: String;
4620 /**
4621 * The date and time to restore from. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Cannot be specified if UseLatestRestorableTime parameter is true Example: 2009-09-07T23:45:00Z
4622 */
4623 RestoreTime?: TStamp;
4624 /**
4625 * Specifies whether (true) or not (false) the DB instance is restored from the latest backup time. Default: false Constraints: Cannot be specified if RestoreTime parameter is provided.
4626 */
4627 UseLatestRestorableTime?: Boolean;
4628 /**
4629 * The compute and memory capacity of the Amazon RDS DB instance. Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large Default: The same DBInstanceClass as the original DB instance.
4630 */
4631 DBInstanceClass?: String;
4632 /**
4633 * The port number on which the database accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB instance.
4634 */
4635 Port?: IntegerOptional;
4636 /**
4637 * The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a
4638 */
4639 AvailabilityZone?: String;
4640 /**
4641 * The DB subnet group name to use for the new instance. Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
4642 */
4643 DBSubnetGroupName?: String;
4644 /**
4645 * Specifies if the DB instance is a Multi-AZ deployment. Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
4646 */
4647 MultiAZ?: BooleanOptional;
4648 /**
4649 * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case. Default VPC:true VPC:false If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
4650 */
4651 PubliclyAccessible?: BooleanOptional;
4652 /**
4653 * Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.
4654 */
4655 AutoMinorVersionUpgrade?: BooleanOptional;
4656 /**
4657 * License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
4658 */
4659 LicenseModel?: String;
4660 /**
4661 * The database name for the restored DB instance. This parameter is not used for the MySQL or MariaDB engines.
4662 */
4663 DBName?: String;
4664 /**
4665 * The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora
4666 */
4667 Engine?: String;
4668 /**
4669 * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be an integer greater than 1000. SQL Server Setting the IOPS value for the SQL Server database engine is not supported.
4670 */
4671 Iops?: IntegerOptional;
4672 /**
4673 * The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
4674 */
4675 OptionGroupName?: String;
4676 /**
4677 * True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.
4678 */
4679 CopyTagsToSnapshot?: BooleanOptional;
4680 Tags?: TagList;
4681 /**
4682 * Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard
4683 */
4684 StorageType?: String;
4685 /**
4686 * The ARN from the Key Store with which to associate the instance for TDE encryption.
4687 */
4688 TdeCredentialArn?: String;
4689 /**
4690 * The password for the given ARN from the Key Store in order to access the device.
4691 */
4692 TdeCredentialPassword?: String;
4693 /**
4694 * Specify the Active Directory Domain to restore the instance in.
4695 */
4696 Domain?: String;
4697 /**
4698 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
4699 */
4700 DomainIAMRoleName?: String;
4701 }
4702 export interface RestoreDBInstanceToPointInTimeResult {
4703 DBInstance?: DBInstance;
4704 }
4705 export interface RevokeDBSecurityGroupIngressMessage {
4706 /**
4707 * The name of the DB security group to revoke ingress from.
4708 */
4709 DBSecurityGroupName: String;
4710 /**
4711 * The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.
4712 */
4713 CIDRIP?: String;
4714 /**
4715 * The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
4716 */
4717 EC2SecurityGroupName?: String;
4718 /**
4719 * The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
4720 */
4721 EC2SecurityGroupId?: String;
4722 /**
4723 * The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
4724 */
4725 EC2SecurityGroupOwnerId?: String;
4726 }
4727 export interface RevokeDBSecurityGroupIngressResult {
4728 DBSecurityGroup?: DBSecurityGroup;
4729 }
4730 export type SourceIdsList = String[];
4731 export interface SourceRegion {
4732 /**
4733 * The source region name.
4734 */
4735 RegionName?: String;
4736 /**
4737 * The source region endpoint.
4738 */
4739 Endpoint?: String;
4740 /**
4741 * The status of the source region.
4742 */
4743 Status?: String;
4744 }
4745 export type SourceRegionList = SourceRegion[];
4746 export interface SourceRegionMessage {
4747 /**
4748 * 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.
4749 */
4750 Marker?: String;
4751 /**
4752 * A list of SourceRegion instances that contains each source AWS Region that the current region can get a Read Replica or a DB snapshot from.
4753 */
4754 SourceRegions?: SourceRegionList;
4755 }
4756 export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
4757 export type String = string;
4758 export interface Subnet {
4759 /**
4760 * Specifies the identifier of the subnet.
4761 */
4762 SubnetIdentifier?: String;
4763 SubnetAvailabilityZone?: AvailabilityZone;
4764 /**
4765 * Specifies the status of the subnet.
4766 */
4767 SubnetStatus?: String;
4768 }
4769 export type SubnetIdentifierList = String[];
4770 export type SubnetList = Subnet[];
4771 export type SupportedCharacterSetsList = CharacterSet[];
4772 export type SupportedTimezonesList = Timezone[];
4773 export type TStamp = Date;
4774 export interface Tag {
4775 /**
4776 * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
4777 */
4778 Key?: String;
4779 /**
4780 * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
4781 */
4782 Value?: String;
4783 }
4784 export type TagList = Tag[];
4785 export interface TagListMessage {
4786 /**
4787 * List of tags returned by the ListTagsForResource operation.
4788 */
4789 TagList?: TagList;
4790 }
4791 export interface Timezone {
4792 /**
4793 * The name of the time zone.
4794 */
4795 TimezoneName?: String;
4796 }
4797 export interface UpgradeTarget {
4798 /**
4799 * The name of the upgrade target database engine.
4800 */
4801 Engine?: String;
4802 /**
4803 * The version number of the upgrade target database engine.
4804 */
4805 EngineVersion?: String;
4806 /**
4807 * The version of the database engine that a DB instance can be upgraded to.
4808 */
4809 Description?: String;
4810 /**
4811 * A value that indicates whether the target version will be applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
4812 */
4813 AutoUpgrade?: Boolean;
4814 /**
4815 * A value that indicates whether a database engine will be upgraded to a major version.
4816 */
4817 IsMajorVersionUpgrade?: Boolean;
4818 }
4819 export type ValidUpgradeTargetList = UpgradeTarget[];
4820 export type VpcSecurityGroupIdList = String[];
4821 export interface VpcSecurityGroupMembership {
4822 /**
4823 * The name of the VPC security group.
4824 */
4825 VpcSecurityGroupId?: String;
4826 /**
4827 * The status of the VPC security group.
4828 */
4829 Status?: String;
4830 }
4831 export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
4832 /**
4833 * 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.
4834 */
4835 export type apiVersion = "2013-01-10"|"2013-02-12"|"2013-09-09"|"2014-09-01"|"2014-10-31"|"latest"|string;
4836 export interface ClientApiVersions {
4837 /**
4838 * 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.
4839 */
4840 apiVersion?: apiVersion;
4841 }
4842 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
4843 }
4844 export = RDS;