UNPKG

439 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8import {Signer as signer} from '../lib/rds/signer';
9interface Blob {}
10declare class RDS extends Service {
11 /**
12 * Constructs a service object. This object has one method for each API operation.
13 */
14 constructor(options?: RDS.Types.ClientConfiguration)
15 config: Config & RDS.Types.ClientConfiguration;
16 /**
17 * Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
18 */
19 addRoleToDBCluster(params: RDS.Types.AddRoleToDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
20 /**
21 * Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
22 */
23 addRoleToDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
24 /**
25 * Associates an AWS Identity and Access Management (IAM) role with a DB instance.
26 */
27 addRoleToDBInstance(params: RDS.Types.AddRoleToDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
28 /**
29 * Associates an AWS Identity and Access Management (IAM) role with a DB instance.
30 */
31 addRoleToDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
32 /**
33 * Adds a source identifier to an existing RDS event notification subscription.
34 */
35 addSourceIdentifierToSubscription(params: RDS.Types.AddSourceIdentifierToSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<RDS.Types.AddSourceIdentifierToSubscriptionResult, AWSError>;
36 /**
37 * Adds a source identifier to an existing RDS event notification subscription.
38 */
39 addSourceIdentifierToSubscription(callback?: (err: AWSError, data: RDS.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<RDS.Types.AddSourceIdentifierToSubscriptionResult, AWSError>;
40 /**
41 * 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.
42 */
43 addTagsToResource(params: RDS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
44 /**
45 * 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.
46 */
47 addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
48 /**
49 * Applies a pending maintenance action to a resource (for example, to a DB instance).
50 */
51 applyPendingMaintenanceAction(params: RDS.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request<RDS.Types.ApplyPendingMaintenanceActionResult, AWSError>;
52 /**
53 * Applies a pending maintenance action to a resource (for example, to a DB instance).
54 */
55 applyPendingMaintenanceAction(callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request<RDS.Types.ApplyPendingMaintenanceActionResult, AWSError>;
56 /**
57 * 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 can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't 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.
58 */
59 authorizeDBSecurityGroupIngress(params: RDS.Types.AuthorizeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
60 /**
61 * 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 can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't 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.
62 */
63 authorizeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
64 /**
65 * Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
66 */
67 backtrackDBCluster(params: RDS.Types.BacktrackDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrack) => void): Request<RDS.Types.DBClusterBacktrack, AWSError>;
68 /**
69 * Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
70 */
71 backtrackDBCluster(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrack) => void): Request<RDS.Types.DBClusterBacktrack, AWSError>;
72 /**
73 * Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters.
74 */
75 copyDBClusterParameterGroup(params: RDS.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
76 /**
77 * Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters.
78 */
79 copyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
80 /**
81 * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
82 */
83 copyDBClusterSnapshot(params: RDS.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
84 /**
85 * Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
86 */
87 copyDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
88 /**
89 * Copies the specified DB parameter group.
90 */
91 copyDBParameterGroup(params: RDS.Types.CopyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
92 /**
93 * Copies the specified DB parameter group.
94 */
95 copyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
96 /**
97 * Copies the specified DB snapshot. The source DB snapshot must be in the "available" state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
98 */
99 copyDBSnapshot(params: RDS.Types.CopyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
100 /**
101 * Copies the specified DB snapshot. The source DB snapshot must be in the "available" state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
102 */
103 copyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
104 /**
105 * Copies the specified option group.
106 */
107 copyOptionGroup(params: RDS.Types.CopyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request<RDS.Types.CopyOptionGroupResult, AWSError>;
108 /**
109 * Copies the specified option group.
110 */
111 copyOptionGroup(callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request<RDS.Types.CopyOptionGroupResult, AWSError>;
112 /**
113 * 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 or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
114 */
115 createDBCluster(params: RDS.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
116 /**
117 * 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 or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
118 */
119 createDBCluster(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
120 /**
121 * Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
122 */
123 createDBClusterEndpoint(params: RDS.Types.CreateDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
124 /**
125 * Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
126 */
127 createDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
128 /**
129 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
130 */
131 createDBClusterParameterGroup(params: RDS.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
132 /**
133 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
134 */
135 createDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
136 /**
137 * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
138 */
139 createDBClusterSnapshot(params: RDS.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
140 /**
141 * Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
142 */
143 createDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
144 /**
145 * Creates a new DB instance.
146 */
147 createDBInstance(params: RDS.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
148 /**
149 * Creates a new DB instance.
150 */
151 createDBInstance(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
152 /**
153 * Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster. All Read Replica DB instances are created 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 following. Your source DB instance must have backup retention enabled.
154 */
155 createDBInstanceReadReplica(params: RDS.Types.CreateDBInstanceReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
156 /**
157 * Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, or PostgreSQL. For more information, see Working with PostgreSQL, MySQL, and MariaDB Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster. All Read Replica DB instances are created 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 following. Your source DB instance must have backup retention enabled.
158 */
159 createDBInstanceReadReplica(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
160 /**
161 * 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.
162 */
163 createDBParameterGroup(params: RDS.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
164 /**
165 * 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.
166 */
167 createDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
168 /**
169 * Creates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
170 */
171 createDBSecurityGroup(params: RDS.Types.CreateDBSecurityGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
172 /**
173 * Creates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
174 */
175 createDBSecurityGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
176 /**
177 * Creates a DBSnapshot. The source DBInstance must be in "available" state.
178 */
179 createDBSnapshot(params: RDS.Types.CreateDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
180 /**
181 * Creates a DBSnapshot. The source DBInstance must be in "available" state.
182 */
183 createDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
184 /**
185 * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
186 */
187 createDBSubnetGroup(params: RDS.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
188 /**
189 * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
190 */
191 createDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
192 /**
193 * 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 are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.
194 */
195 createEventSubscription(params: RDS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
196 /**
197 * 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 are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.
198 */
199 createEventSubscription(callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
200 /**
201 * Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action only applies to Aurora DB clusters.
202 */
203 createGlobalCluster(params: RDS.Types.CreateGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
204 /**
205 * Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action only applies to Aurora DB clusters.
206 */
207 createGlobalCluster(callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
208 /**
209 * Creates a new option group. You can create up to 20 option groups.
210 */
211 createOptionGroup(params: RDS.Types.CreateOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
212 /**
213 * Creates a new option group. You can create up to 20 option groups.
214 */
215 createOptionGroup(callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
216 /**
217 * 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 can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
218 */
219 deleteDBCluster(params: RDS.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
220 /**
221 * 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 can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
222 */
223 deleteDBCluster(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
224 /**
225 * Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
226 */
227 deleteDBClusterEndpoint(params: RDS.Types.DeleteDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
228 /**
229 * Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
230 */
231 deleteDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
232 /**
233 * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
234 */
235 deleteDBClusterParameterGroup(params: RDS.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
236 /**
237 * Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
238 */
239 deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
240 /**
241 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
242 */
243 deleteDBClusterSnapshot(params: RDS.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
244 /**
245 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
246 */
247 deleteDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
248 /**
249 * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't 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 can't 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 can't delete the DB instance if both of the following conditions 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.
250 */
251 deleteDBInstance(params: RDS.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
252 /**
253 * The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't 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 can't 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 can't delete the DB instance if both of the following conditions 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.
254 */
255 deleteDBInstance(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
256 /**
257 * Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.
258 */
259 deleteDBInstanceAutomatedBackup(params: RDS.Types.DeleteDBInstanceAutomatedBackupMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request<RDS.Types.DeleteDBInstanceAutomatedBackupResult, AWSError>;
260 /**
261 * Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.
262 */
263 deleteDBInstanceAutomatedBackup(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request<RDS.Types.DeleteDBInstanceAutomatedBackupResult, AWSError>;
264 /**
265 * Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
266 */
267 deleteDBParameterGroup(params: RDS.Types.DeleteDBParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
268 /**
269 * Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
270 */
271 deleteDBParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
272 /**
273 * Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
274 */
275 deleteDBSecurityGroup(params: RDS.Types.DeleteDBSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
276 /**
277 * Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
278 */
279 deleteDBSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
280 /**
281 * Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted.
282 */
283 deleteDBSnapshot(params: RDS.Types.DeleteDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request<RDS.Types.DeleteDBSnapshotResult, AWSError>;
284 /**
285 * Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted.
286 */
287 deleteDBSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request<RDS.Types.DeleteDBSnapshotResult, AWSError>;
288 /**
289 * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
290 */
291 deleteDBSubnetGroup(params: RDS.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
292 /**
293 * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
294 */
295 deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
296 /**
297 * Deletes an RDS event notification subscription.
298 */
299 deleteEventSubscription(params: RDS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request<RDS.Types.DeleteEventSubscriptionResult, AWSError>;
300 /**
301 * Deletes an RDS event notification subscription.
302 */
303 deleteEventSubscription(callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request<RDS.Types.DeleteEventSubscriptionResult, AWSError>;
304 /**
305 * Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters.
306 */
307 deleteGlobalCluster(params: RDS.Types.DeleteGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteGlobalClusterResult) => void): Request<RDS.Types.DeleteGlobalClusterResult, AWSError>;
308 /**
309 * Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters.
310 */
311 deleteGlobalCluster(callback?: (err: AWSError, data: RDS.Types.DeleteGlobalClusterResult) => void): Request<RDS.Types.DeleteGlobalClusterResult, AWSError>;
312 /**
313 * Deletes an existing option group.
314 */
315 deleteOptionGroup(params: RDS.Types.DeleteOptionGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
316 /**
317 * Deletes an existing option group.
318 */
319 deleteOptionGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
320 /**
321 * 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 doesn't take any parameters.
322 */
323 describeAccountAttributes(params: RDS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request<RDS.Types.AccountAttributesMessage, AWSError>;
324 /**
325 * 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 doesn't take any parameters.
326 */
327 describeAccountAttributes(callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request<RDS.Types.AccountAttributesMessage, AWSError>;
328 /**
329 * Lists the set of CA certificates provided by Amazon RDS for this AWS account.
330 */
331 describeCertificates(params: RDS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request<RDS.Types.CertificateMessage, AWSError>;
332 /**
333 * Lists the set of CA certificates provided by Amazon RDS for this AWS account.
334 */
335 describeCertificates(callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request<RDS.Types.CertificateMessage, AWSError>;
336 /**
337 * Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
338 */
339 describeDBClusterBacktracks(params: RDS.Types.DescribeDBClusterBacktracksMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request<RDS.Types.DBClusterBacktrackMessage, AWSError>;
340 /**
341 * Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
342 */
343 describeDBClusterBacktracks(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request<RDS.Types.DBClusterBacktrackMessage, AWSError>;
344 /**
345 * Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
346 */
347 describeDBClusterEndpoints(params: RDS.Types.DescribeDBClusterEndpointsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request<RDS.Types.DBClusterEndpointMessage, AWSError>;
348 /**
349 * Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
350 */
351 describeDBClusterEndpoints(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request<RDS.Types.DBClusterEndpointMessage, AWSError>;
352 /**
353 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
354 */
355 describeDBClusterParameterGroups(params: RDS.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
356 /**
357 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
358 */
359 describeDBClusterParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
360 /**
361 * Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
362 */
363 describeDBClusterParameters(params: RDS.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
364 /**
365 * Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
366 */
367 describeDBClusterParameters(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
368 /**
369 * 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. This action only applies to Aurora DB clusters.
370 */
371 describeDBClusterSnapshotAttributes(params: RDS.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
372 /**
373 * 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. This action only applies to Aurora DB clusters.
374 */
375 describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
376 /**
377 * Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
378 */
379 describeDBClusterSnapshots(params: RDS.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
380 /**
381 * Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
382 */
383 describeDBClusterSnapshots(callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
384 /**
385 * Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
386 */
387 describeDBClusters(params: RDS.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
388 /**
389 * Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
390 */
391 describeDBClusters(callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
392 /**
393 * Returns a list of the available DB engines.
394 */
395 describeDBEngineVersions(params: RDS.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request<RDS.Types.DBEngineVersionMessage, AWSError>;
396 /**
397 * Returns a list of the available DB engines.
398 */
399 describeDBEngineVersions(callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request<RDS.Types.DBEngineVersionMessage, AWSError>;
400 /**
401 * Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations. All parameters are optional.
402 */
403 describeDBInstanceAutomatedBackups(params: RDS.Types.DescribeDBInstanceAutomatedBackupsMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request<RDS.Types.DBInstanceAutomatedBackupMessage, AWSError>;
404 /**
405 * Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations. All parameters are optional.
406 */
407 describeDBInstanceAutomatedBackups(callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request<RDS.Types.DBInstanceAutomatedBackupMessage, AWSError>;
408 /**
409 * Returns information about provisioned RDS instances. This API supports pagination.
410 */
411 describeDBInstances(params: RDS.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
412 /**
413 * Returns information about provisioned RDS instances. This API supports pagination.
414 */
415 describeDBInstances(callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
416 /**
417 * Returns a list of DB log files for the DB instance.
418 */
419 describeDBLogFiles(params: RDS.Types.DescribeDBLogFilesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
420 /**
421 * Returns a list of DB log files for the DB instance.
422 */
423 describeDBLogFiles(callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
424 /**
425 * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
426 */
427 describeDBParameterGroups(params: RDS.Types.DescribeDBParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request<RDS.Types.DBParameterGroupsMessage, AWSError>;
428 /**
429 * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
430 */
431 describeDBParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request<RDS.Types.DBParameterGroupsMessage, AWSError>;
432 /**
433 * Returns the detailed parameter list for a particular DB parameter group.
434 */
435 describeDBParameters(params: RDS.Types.DescribeDBParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request<RDS.Types.DBParameterGroupDetails, AWSError>;
436 /**
437 * Returns the detailed parameter list for a particular DB parameter group.
438 */
439 describeDBParameters(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request<RDS.Types.DBParameterGroupDetails, AWSError>;
440 /**
441 * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
442 */
443 describeDBSecurityGroups(params: RDS.Types.DescribeDBSecurityGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request<RDS.Types.DBSecurityGroupMessage, AWSError>;
444 /**
445 * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
446 */
447 describeDBSecurityGroups(callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request<RDS.Types.DBSecurityGroupMessage, AWSError>;
448 /**
449 * 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.
450 */
451 describeDBSnapshotAttributes(params: RDS.Types.DescribeDBSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBSnapshotAttributesResult, AWSError>;
452 /**
453 * 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.
454 */
455 describeDBSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBSnapshotAttributesResult, AWSError>;
456 /**
457 * Returns information about DB snapshots. This API action supports pagination.
458 */
459 describeDBSnapshots(params: RDS.Types.DescribeDBSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
460 /**
461 * Returns information about DB snapshots. This API action supports pagination.
462 */
463 describeDBSnapshots(callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
464 /**
465 * 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.
466 */
467 describeDBSubnetGroups(params: RDS.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
468 /**
469 * 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.
470 */
471 describeDBSubnetGroups(callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
472 /**
473 * Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
474 */
475 describeEngineDefaultClusterParameters(params: RDS.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
476 /**
477 * Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
478 */
479 describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
480 /**
481 * Returns the default engine and system parameter information for the specified database engine.
482 */
483 describeEngineDefaultParameters(params: RDS.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultParametersResult, AWSError>;
484 /**
485 * Returns the default engine and system parameter information for the specified database engine.
486 */
487 describeEngineDefaultParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultParametersResult, AWSError>;
488 /**
489 * 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.
490 */
491 describeEventCategories(params: RDS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request<RDS.Types.EventCategoriesMessage, AWSError>;
492 /**
493 * 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.
494 */
495 describeEventCategories(callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request<RDS.Types.EventCategoriesMessage, AWSError>;
496 /**
497 * 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.
498 */
499 describeEventSubscriptions(params: RDS.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
500 /**
501 * 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.
502 */
503 describeEventSubscriptions(callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
504 /**
505 * 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.
506 */
507 describeEvents(params: RDS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
508 /**
509 * 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.
510 */
511 describeEvents(callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
512 /**
513 * Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
514 */
515 describeGlobalClusters(params: RDS.Types.DescribeGlobalClustersMessage, callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request<RDS.Types.GlobalClustersMessage, AWSError>;
516 /**
517 * Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
518 */
519 describeGlobalClusters(callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request<RDS.Types.GlobalClustersMessage, AWSError>;
520 /**
521 * Describes all available options.
522 */
523 describeOptionGroupOptions(params: RDS.Types.DescribeOptionGroupOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request<RDS.Types.OptionGroupOptionsMessage, AWSError>;
524 /**
525 * Describes all available options.
526 */
527 describeOptionGroupOptions(callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request<RDS.Types.OptionGroupOptionsMessage, AWSError>;
528 /**
529 * Describes the available option groups.
530 */
531 describeOptionGroups(params: RDS.Types.DescribeOptionGroupsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
532 /**
533 * Describes the available option groups.
534 */
535 describeOptionGroups(callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
536 /**
537 * Returns a list of orderable DB instance options for the specified engine.
538 */
539 describeOrderableDBInstanceOptions(params: RDS.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
540 /**
541 * Returns a list of orderable DB instance options for the specified engine.
542 */
543 describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
544 /**
545 * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
546 */
547 describePendingMaintenanceActions(params: RDS.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request<RDS.Types.PendingMaintenanceActionsMessage, AWSError>;
548 /**
549 * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
550 */
551 describePendingMaintenanceActions(callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request<RDS.Types.PendingMaintenanceActionsMessage, AWSError>;
552 /**
553 * Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
554 */
555 describeReservedDBInstances(params: RDS.Types.DescribeReservedDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request<RDS.Types.ReservedDBInstanceMessage, AWSError>;
556 /**
557 * Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
558 */
559 describeReservedDBInstances(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request<RDS.Types.ReservedDBInstanceMessage, AWSError>;
560 /**
561 * Lists available reserved DB instance offerings.
562 */
563 describeReservedDBInstancesOfferings(params: RDS.Types.DescribeReservedDBInstancesOfferingsMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request<RDS.Types.ReservedDBInstancesOfferingMessage, AWSError>;
564 /**
565 * Lists available reserved DB instance offerings.
566 */
567 describeReservedDBInstancesOfferings(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request<RDS.Types.ReservedDBInstancesOfferingMessage, AWSError>;
568 /**
569 * 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.
570 */
571 describeSourceRegions(params: RDS.Types.DescribeSourceRegionsMessage, callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
572 /**
573 * 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.
574 */
575 describeSourceRegions(callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
576 /**
577 * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
578 */
579 describeValidDBInstanceModifications(params: RDS.Types.DescribeValidDBInstanceModificationsMessage, callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
580 /**
581 * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
582 */
583 describeValidDBInstanceModifications(callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
584 /**
585 * Downloads all or a portion of the specified log file, up to 1 MB in size.
586 */
587 downloadDBLogFilePortion(params: RDS.Types.DownloadDBLogFilePortionMessage, callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
588 /**
589 * Downloads all or a portion of the specified log file, up to 1 MB in size.
590 */
591 downloadDBLogFilePortion(callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
592 /**
593 * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
594 */
595 failoverDBCluster(params: RDS.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
596 /**
597 * Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
598 */
599 failoverDBCluster(callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
600 /**
601 * Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
602 */
603 listTagsForResource(params: RDS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request<RDS.Types.TagListMessage, AWSError>;
604 /**
605 * Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
606 */
607 listTagsForResource(callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request<RDS.Types.TagListMessage, AWSError>;
608 /**
609 * Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
610 */
611 modifyCurrentDBClusterCapacity(params: RDS.Types.ModifyCurrentDBClusterCapacityMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
612 /**
613 * Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
614 */
615 modifyCurrentDBClusterCapacity(callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
616 /**
617 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
618 */
619 modifyDBCluster(params: RDS.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
620 /**
621 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
622 */
623 modifyDBCluster(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
624 /**
625 * Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
626 */
627 modifyDBClusterEndpoint(params: RDS.Types.ModifyDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
628 /**
629 * Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
630 */
631 modifyDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
632 /**
633 * 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 What Is Amazon Aurora? in the Amazon Aurora 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. This action only applies to Aurora DB clusters.
634 */
635 modifyDBClusterParameterGroup(params: RDS.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
636 /**
637 * 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 What Is Amazon Aurora? in the Amazon Aurora 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. This action only applies to Aurora DB clusters.
638 */
639 modifyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
640 /**
641 * 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. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. 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. This action only applies to Aurora DB clusters.
642 */
643 modifyDBClusterSnapshotAttribute(params: RDS.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
644 /**
645 * 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. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. 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. This action only applies to Aurora DB clusters.
646 */
647 modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
648 /**
649 * 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. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
650 */
651 modifyDBInstance(params: RDS.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request<RDS.Types.ModifyDBInstanceResult, AWSError>;
652 /**
653 * 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. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
654 */
655 modifyDBInstance(callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request<RDS.Types.ModifyDBInstanceResult, AWSError>;
656 /**
657 * 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.
658 */
659 modifyDBParameterGroup(params: RDS.Types.ModifyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
660 /**
661 * 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.
662 */
663 modifyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
664 /**
665 * Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.
666 */
667 modifyDBSnapshot(params: RDS.Types.ModifyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
668 /**
669 * Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.
670 */
671 modifyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
672 /**
673 * 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. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. 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.
674 */
675 modifyDBSnapshotAttribute(params: RDS.Types.ModifyDBSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
676 /**
677 * 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. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. 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.
678 */
679 modifyDBSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
680 /**
681 * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
682 */
683 modifyDBSubnetGroup(params: RDS.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request<RDS.Types.ModifyDBSubnetGroupResult, AWSError>;
684 /**
685 * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
686 */
687 modifyDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request<RDS.Types.ModifyDBSubnetGroupResult, AWSError>;
688 /**
689 * Modifies an existing RDS event notification subscription. Note that you can't 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.
690 */
691 modifyEventSubscription(params: RDS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
692 /**
693 * Modifies an existing RDS event notification subscription. Note that you can't 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.
694 */
695 modifyEventSubscription(callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
696 /**
697 * Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
698 */
699 modifyGlobalCluster(params: RDS.Types.ModifyGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request<RDS.Types.ModifyGlobalClusterResult, AWSError>;
700 /**
701 * Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
702 */
703 modifyGlobalCluster(callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request<RDS.Types.ModifyGlobalClusterResult, AWSError>;
704 /**
705 * Modifies an existing option group.
706 */
707 modifyOptionGroup(params: RDS.Types.ModifyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
708 /**
709 * Modifies an existing option group.
710 */
711 modifyOptionGroup(callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
712 /**
713 * Promotes a Read Replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
714 */
715 promoteReadReplica(params: RDS.Types.PromoteReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
716 /**
717 * Promotes a Read Replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
718 */
719 promoteReadReplica(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
720 /**
721 * Promotes a Read Replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters.
722 */
723 promoteReadReplicaDBCluster(params: RDS.Types.PromoteReadReplicaDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
724 /**
725 * Promotes a Read Replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters.
726 */
727 promoteReadReplicaDBCluster(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
728 /**
729 * Purchases a reserved DB instance offering.
730 */
731 purchaseReservedDBInstancesOffering(params: RDS.Types.PurchaseReservedDBInstancesOfferingMessage, callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
732 /**
733 * Purchases a reserved DB instance offering.
734 */
735 purchaseReservedDBInstancesOffering(callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
736 /**
737 * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
738 */
739 rebootDBInstance(params: RDS.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
740 /**
741 * You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
742 */
743 rebootDBInstance(callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
744 /**
745 * Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region. This action only applies to Aurora DB clusters.
746 */
747 removeFromGlobalCluster(params: RDS.Types.RemoveFromGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request<RDS.Types.RemoveFromGlobalClusterResult, AWSError>;
748 /**
749 * Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region. This action only applies to Aurora DB clusters.
750 */
751 removeFromGlobalCluster(callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request<RDS.Types.RemoveFromGlobalClusterResult, AWSError>;
752 /**
753 * Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
754 */
755 removeRoleFromDBCluster(params: RDS.Types.RemoveRoleFromDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
756 /**
757 * Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
758 */
759 removeRoleFromDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
760 /**
761 * Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
762 */
763 removeRoleFromDBInstance(params: RDS.Types.RemoveRoleFromDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
764 /**
765 * Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
766 */
767 removeRoleFromDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
768 /**
769 * Removes a source identifier from an existing RDS event notification subscription.
770 */
771 removeSourceIdentifierFromSubscription(params: RDS.Types.RemoveSourceIdentifierFromSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<RDS.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
772 /**
773 * Removes a source identifier from an existing RDS event notification subscription.
774 */
775 removeSourceIdentifierFromSubscription(callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<RDS.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
776 /**
777 * Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
778 */
779 removeTagsFromResource(params: RDS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
780 /**
781 * Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
782 */
783 removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
784 /**
785 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
786 */
787 resetDBClusterParameterGroup(params: RDS.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
788 /**
789 * 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
790 */
791 resetDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
792 /**
793 * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide 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.
794 */
795 resetDBParameterGroup(params: RDS.Types.ResetDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
796 /**
797 * Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide 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.
798 */
799 resetDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
800 /**
801 * 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 to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
802 */
803 restoreDBClusterFromS3(params: RDS.Types.RestoreDBClusterFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
804 /**
805 * 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 to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
806 */
807 restoreDBClusterFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
808 /**
809 * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
810 */
811 restoreDBClusterFromSnapshot(params: RDS.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
812 /**
813 * Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, 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 What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
814 */
815 restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
816 /**
817 * 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. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
818 */
819 restoreDBClusterToPointInTime(params: RDS.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
820 /**
821 * 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. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
822 */
823 restoreDBClusterToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
824 /**
825 * 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 doesn't 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. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
826 */
827 restoreDBInstanceFromDBSnapshot(params: RDS.Types.RestoreDBInstanceFromDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
828 /**
829 * 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 doesn't 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. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
830 */
831 restoreDBInstanceFromDBSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
832 /**
833 * Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
834 */
835 restoreDBInstanceFromS3(params: RDS.Types.RestoreDBInstanceFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
836 /**
837 * Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
838 */
839 restoreDBInstanceFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
840 /**
841 * 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. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
842 */
843 restoreDBInstanceToPointInTime(params: RDS.Types.RestoreDBInstanceToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request<RDS.Types.RestoreDBInstanceToPointInTimeResult, AWSError>;
844 /**
845 * 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. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
846 */
847 restoreDBInstanceToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request<RDS.Types.RestoreDBInstanceToPointInTimeResult, AWSError>;
848 /**
849 * 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).
850 */
851 revokeDBSecurityGroupIngress(params: RDS.Types.RevokeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request<RDS.Types.RevokeDBSecurityGroupIngressResult, AWSError>;
852 /**
853 * 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).
854 */
855 revokeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request<RDS.Types.RevokeDBSecurityGroupIngressResult, AWSError>;
856 /**
857 * Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
858 */
859 startDBCluster(params: RDS.Types.StartDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request<RDS.Types.StartDBClusterResult, AWSError>;
860 /**
861 * Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
862 */
863 startDBCluster(callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request<RDS.Types.StartDBClusterResult, AWSError>;
864 /**
865 * Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
866 */
867 startDBInstance(params: RDS.Types.StartDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
868 /**
869 * Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
870 */
871 startDBInstance(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
872 /**
873 * Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
874 */
875 stopDBCluster(params: RDS.Types.StopDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request<RDS.Types.StopDBClusterResult, AWSError>;
876 /**
877 * Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
878 */
879 stopDBCluster(callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request<RDS.Types.StopDBClusterResult, AWSError>;
880 /**
881 * Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
882 */
883 stopDBInstance(params: RDS.Types.StopDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
884 /**
885 * Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
886 */
887 stopDBInstance(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
888 /**
889 * Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
890 */
891 waitFor(state: "dBInstanceAvailable", params: RDS.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
892 /**
893 * Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
894 */
895 waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
896 /**
897 * Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
898 */
899 waitFor(state: "dBInstanceDeleted", params: RDS.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
900 /**
901 * Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
902 */
903 waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
904 /**
905 * Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
906 */
907 waitFor(state: "dBSnapshotAvailable", params: RDS.Types.DescribeDBSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
908 /**
909 * Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
910 */
911 waitFor(state: "dBSnapshotAvailable", callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
912 /**
913 * Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
914 */
915 waitFor(state: "dBSnapshotDeleted", params: RDS.Types.DescribeDBSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
916 /**
917 * Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
918 */
919 waitFor(state: "dBSnapshotDeleted", callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
920}
921declare namespace RDS {
922 export import Signer = signer;
923}
924declare namespace RDS {
925 export interface AccountAttributesMessage {
926 /**
927 * 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.
928 */
929 AccountQuotas?: AccountQuotaList;
930 }
931 export interface AccountQuota {
932 /**
933 * The name of the Amazon RDS quota for this AWS account.
934 */
935 AccountQuotaName?: String;
936 /**
937 * The amount currently used toward the quota maximum.
938 */
939 Used?: Long;
940 /**
941 * The maximum allowed value for the quota.
942 */
943 Max?: Long;
944 }
945 export type AccountQuotaList = AccountQuota[];
946 export interface AddRoleToDBClusterMessage {
947 /**
948 * The name of the DB cluster to associate the IAM role with.
949 */
950 DBClusterIdentifier: String;
951 /**
952 * The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
953 */
954 RoleArn: String;
955 }
956 export interface AddRoleToDBInstanceMessage {
957 /**
958 * The name of the DB instance to associate the IAM role with.
959 */
960 DBInstanceIdentifier: String;
961 /**
962 * The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
963 */
964 RoleArn: String;
965 /**
966 * The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.
967 */
968 FeatureName: String;
969 }
970 export interface AddSourceIdentifierToSubscriptionMessage {
971 /**
972 * The name of the RDS event notification subscription you want to add a source identifier to.
973 */
974 SubscriptionName: String;
975 /**
976 * The identifier of the event source to be added. 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.
977 */
978 SourceIdentifier: String;
979 }
980 export interface AddSourceIdentifierToSubscriptionResult {
981 EventSubscription?: EventSubscription;
982 }
983 export interface AddTagsToResourceMessage {
984 /**
985 * The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
986 */
987 ResourceName: String;
988 /**
989 * The tags to be assigned to the Amazon RDS resource.
990 */
991 Tags: TagList;
992 }
993 export type ApplyMethod = "immediate"|"pending-reboot"|string;
994 export interface ApplyPendingMaintenanceActionMessage {
995 /**
996 * 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).
997 */
998 ResourceIdentifier: String;
999 /**
1000 * The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade
1001 */
1002 ApplyAction: String;
1003 /**
1004 * A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests.
1005 */
1006 OptInType: String;
1007 }
1008 export interface ApplyPendingMaintenanceActionResult {
1009 ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions;
1010 }
1011 export type AttributeValueList = String[];
1012 export interface AuthorizeDBSecurityGroupIngressMessage {
1013 /**
1014 * The name of the DB security group to add authorization to.
1015 */
1016 DBSecurityGroupName: String;
1017 /**
1018 * The IP range to authorize.
1019 */
1020 CIDRIP?: String;
1021 /**
1022 * 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.
1023 */
1024 EC2SecurityGroupName?: String;
1025 /**
1026 * 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.
1027 */
1028 EC2SecurityGroupId?: String;
1029 /**
1030 * 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.
1031 */
1032 EC2SecurityGroupOwnerId?: String;
1033 }
1034 export interface AuthorizeDBSecurityGroupIngressResult {
1035 DBSecurityGroup?: DBSecurityGroup;
1036 }
1037 export interface AvailabilityZone {
1038 /**
1039 * The name of the Availability Zone.
1040 */
1041 Name?: String;
1042 }
1043 export type AvailabilityZoneList = AvailabilityZone[];
1044 export type AvailabilityZones = String[];
1045 export interface AvailableProcessorFeature {
1046 /**
1047 * The name of the processor feature. Valid names are coreCount and threadsPerCore.
1048 */
1049 Name?: String;
1050 /**
1051 * The default value for the processor feature of the DB instance class.
1052 */
1053 DefaultValue?: String;
1054 /**
1055 * The allowed values for the processor feature of the DB instance class.
1056 */
1057 AllowedValues?: String;
1058 }
1059 export type AvailableProcessorFeatureList = AvailableProcessorFeature[];
1060 export interface BacktrackDBClusterMessage {
1061 /**
1062 * The DB cluster identifier of the DB cluster to be backtracked. 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. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
1063 */
1064 DBClusterIdentifier: String;
1065 /**
1066 * The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page. If the specified time is not a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster. Constraints: Must contain a valid ISO 8601 timestamp. Can't contain a timestamp set in the future. Example: 2017-07-08T18:00Z
1067 */
1068 BacktrackTo: TStamp;
1069 /**
1070 * A value that, if specified, forces the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
1071 */
1072 Force?: BooleanOptional;
1073 /**
1074 * If BacktrackTo is set to a timestamp earlier than the earliest backtrack time, this value backtracks the DB cluster to the earliest possible backtrack time. Otherwise, an error occurs.
1075 */
1076 UseEarliestTimeOnPointInTimeUnavailable?: BooleanOptional;
1077 }
1078 export type Boolean = boolean;
1079 export type BooleanOptional = boolean;
1080 export interface Certificate {
1081 /**
1082 * The unique key that identifies a certificate.
1083 */
1084 CertificateIdentifier?: String;
1085 /**
1086 * The type of the certificate.
1087 */
1088 CertificateType?: String;
1089 /**
1090 * The thumbprint of the certificate.
1091 */
1092 Thumbprint?: String;
1093 /**
1094 * The starting date from which the certificate is valid.
1095 */
1096 ValidFrom?: TStamp;
1097 /**
1098 * The final date that the certificate continues to be valid.
1099 */
1100 ValidTill?: TStamp;
1101 /**
1102 * The Amazon Resource Name (ARN) for the certificate.
1103 */
1104 CertificateArn?: String;
1105 }
1106 export type CertificateList = Certificate[];
1107 export interface CertificateMessage {
1108 /**
1109 * The list of Certificate objects for the AWS account.
1110 */
1111 Certificates?: CertificateList;
1112 /**
1113 * 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 .
1114 */
1115 Marker?: String;
1116 }
1117 export interface CharacterSet {
1118 /**
1119 * The name of the character set.
1120 */
1121 CharacterSetName?: String;
1122 /**
1123 * The description of the character set.
1124 */
1125 CharacterSetDescription?: String;
1126 }
1127 export interface CloudwatchLogsExportConfiguration {
1128 /**
1129 * The list of log types to enable.
1130 */
1131 EnableLogTypes?: LogTypeList;
1132 /**
1133 * The list of log types to disable.
1134 */
1135 DisableLogTypes?: LogTypeList;
1136 }
1137 export interface CopyDBClusterParameterGroupMessage {
1138 /**
1139 * The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide. Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same AWS 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 AWS 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.
1140 */
1141 SourceDBClusterParameterGroupIdentifier: String;
1142 /**
1143 * The identifier for the copied DB cluster parameter group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster-param-group1
1144 */
1145 TargetDBClusterParameterGroupIdentifier: String;
1146 /**
1147 * A description for the copied DB cluster parameter group.
1148 */
1149 TargetDBClusterParameterGroupDescription: String;
1150 Tags?: TagList;
1151 }
1152 export interface CopyDBClusterParameterGroupResult {
1153 DBClusterParameterGroup?: DBClusterParameterGroup;
1154 }
1155 export interface CopyDBClusterSnapshotMessage {
1156 /**
1157 * The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another. Constraints: Must specify a valid system snapshot in the "available" state. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide. Example: my-cluster-snapshot1
1158 */
1159 SourceDBClusterSnapshotIdentifier: String;
1160 /**
1161 * 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 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2
1162 */
1163 TargetDBClusterSnapshotIdentifier: String;
1164 /**
1165 * The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB cluster 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 cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
1166 */
1167 KmsKeyId?: String;
1168 /**
1169 * The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
1170 */
1171 PreSignedUrl?: String;
1172 /**
1173 * True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.
1174 */
1175 CopyTags?: BooleanOptional;
1176 Tags?: TagList;
1177 /**
1178 * The ID of the region that contains the snapshot to be copied.
1179 */
1180 SourceRegion?: String;
1181 }
1182 export interface CopyDBClusterSnapshotResult {
1183 DBClusterSnapshot?: DBClusterSnapshot;
1184 }
1185 export interface CopyDBParameterGroupMessage {
1186 /**
1187 * The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. 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.
1188 */
1189 SourceDBParameterGroupIdentifier: String;
1190 /**
1191 * The identifier for the copied DB parameter group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-db-parameter-group
1192 */
1193 TargetDBParameterGroupIdentifier: String;
1194 /**
1195 * A description for the copied DB parameter group.
1196 */
1197 TargetDBParameterGroupDescription: String;
1198 Tags?: TagList;
1199 }
1200 export interface CopyDBParameterGroupResult {
1201 DBParameterGroup?: DBParameterGroup;
1202 }
1203 export interface CopyDBSnapshotMessage {
1204 /**
1205 * The identifier for the source DB snapshot. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805. If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805. If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter. Constraints: Must specify a valid system snapshot in the "available" state. Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
1206 */
1207 SourceDBSnapshotIdentifier: String;
1208 /**
1209 * The identifier for the copy of the snapshot. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot
1210 */
1211 TargetDBSnapshotIdentifier: String;
1212 /**
1213 * The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, 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 this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
1214 */
1215 KmsKeyId?: String;
1216 Tags?: TagList;
1217 /**
1218 * True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is false.
1219 */
1220 CopyTags?: BooleanOptional;
1221 /**
1222 * The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you copy an encrypted DB snapshot from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
1223 */
1224 PreSignedUrl?: String;
1225 /**
1226 * The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.
1227 */
1228 OptionGroupName?: String;
1229 /**
1230 * The ID of the region that contains the snapshot to be copied.
1231 */
1232 SourceRegion?: String;
1233 }
1234 export interface CopyDBSnapshotResult {
1235 DBSnapshot?: DBSnapshot;
1236 }
1237 export interface CopyOptionGroupMessage {
1238 /**
1239 * The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. Constraints: Must specify a valid option group. If the source option group is in the same AWS 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 AWS Region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.
1240 */
1241 SourceOptionGroupIdentifier: String;
1242 /**
1243 * The identifier for the copied option group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-option-group
1244 */
1245 TargetOptionGroupIdentifier: String;
1246 /**
1247 * The description for the copied option group.
1248 */
1249 TargetOptionGroupDescription: String;
1250 Tags?: TagList;
1251 }
1252 export interface CopyOptionGroupResult {
1253 OptionGroup?: OptionGroup;
1254 }
1255 export interface CreateDBClusterEndpointMessage {
1256 /**
1257 * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
1258 */
1259 DBClusterIdentifier: String;
1260 /**
1261 * The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
1262 */
1263 DBClusterEndpointIdentifier: String;
1264 /**
1265 * The type of the endpoint. One of: READER, ANY.
1266 */
1267 EndpointType: String;
1268 /**
1269 * List of DB instance identifiers that are part of the custom endpoint group.
1270 */
1271 StaticMembers?: StringList;
1272 /**
1273 * List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
1274 */
1275 ExcludedMembers?: StringList;
1276 }
1277 export interface CreateDBClusterMessage {
1278 /**
1279 * A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
1280 */
1281 AvailabilityZones?: AvailabilityZones;
1282 /**
1283 * 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
1284 */
1285 BackupRetentionPeriod?: IntegerOptional;
1286 /**
1287 * A value that indicates that the DB cluster should be associated with the specified CharacterSet.
1288 */
1289 CharacterSetName?: String;
1290 /**
1291 * The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
1292 */
1293 DatabaseName?: String;
1294 /**
1295 * The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
1296 */
1297 DBClusterIdentifier: String;
1298 /**
1299 * The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group.
1300 */
1301 DBClusterParameterGroupName?: String;
1302 /**
1303 * A list of EC2 VPC security groups to associate with this DB cluster.
1304 */
1305 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1306 /**
1307 * A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
1308 */
1309 DBSubnetGroupName?: String;
1310 /**
1311 * The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
1312 */
1313 Engine: String;
1314 /**
1315 * The version number of the database engine to use. Aurora MySQL Example: 5.6.10a, 5.7.12 Aurora PostgreSQL Example: 9.6.3
1316 */
1317 EngineVersion?: String;
1318 /**
1319 * The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
1320 */
1321 Port?: IntegerOptional;
1322 /**
1323 * The name of the master user for the DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
1324 */
1325 MasterUsername?: String;
1326 /**
1327 * 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.
1328 */
1329 MasterUserPassword?: String;
1330 /**
1331 * A value that indicates that the DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
1332 */
1333 OptionGroupName?: String;
1334 /**
1335 * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
1336 */
1337 PreferredBackupWindow?: String;
1338 /**
1339 * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
1340 */
1341 PreferredMaintenanceWindow?: String;
1342 /**
1343 * The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
1344 */
1345 ReplicationSourceIdentifier?: String;
1346 Tags?: TagList;
1347 /**
1348 * Specifies whether the DB cluster is encrypted.
1349 */
1350 StorageEncrypted?: BooleanOptional;
1351 /**
1352 * The AWS 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 KMS encryption key. If an encryption key is not specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key. If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, 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. If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.
1353 */
1354 KmsKeyId?: String;
1355 /**
1356 * A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in. ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
1357 */
1358 PreSignedUrl?: String;
1359 /**
1360 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
1361 */
1362 EnableIAMDatabaseAuthentication?: BooleanOptional;
1363 /**
1364 * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
1365 */
1366 BacktrackWindow?: LongOptional;
1367 /**
1368 * The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
1369 */
1370 EnableCloudwatchLogsExports?: LogTypeList;
1371 /**
1372 * The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global.
1373 */
1374 EngineMode?: String;
1375 /**
1376 * For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
1377 */
1378 ScalingConfiguration?: ScalingConfiguration;
1379 /**
1380 * Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
1381 */
1382 DeletionProtection?: BooleanOptional;
1383 /**
1384 * The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
1385 */
1386 GlobalClusterIdentifier?: String;
1387 /**
1388 * True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false.
1389 */
1390 CopyTagsToSnapshot?: BooleanOptional;
1391 /**
1392 * The ID of the region that contains the source for the read replica.
1393 */
1394 SourceRegion?: String;
1395 }
1396 export interface CreateDBClusterParameterGroupMessage {
1397 /**
1398 * The name of the DB cluster parameter group. Constraints: Must match the name of an existing DB cluster parameter group. This value is stored as a lowercase string.
1399 */
1400 DBClusterParameterGroupName: String;
1401 /**
1402 * 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. Aurora MySQL Example: aurora5.6, aurora-mysql5.7 Aurora PostgreSQL Example: aurora-postgresql9.6
1403 */
1404 DBParameterGroupFamily: String;
1405 /**
1406 * The description for the DB cluster parameter group.
1407 */
1408 Description: String;
1409 Tags?: TagList;
1410 }
1411 export interface CreateDBClusterParameterGroupResult {
1412 DBClusterParameterGroup?: DBClusterParameterGroup;
1413 }
1414 export interface CreateDBClusterResult {
1415 DBCluster?: DBCluster;
1416 }
1417 export interface CreateDBClusterSnapshotMessage {
1418 /**
1419 * The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1
1420 */
1421 DBClusterSnapshotIdentifier: String;
1422 /**
1423 * The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster1
1424 */
1425 DBClusterIdentifier: String;
1426 /**
1427 * The tags to be assigned to the DB cluster snapshot.
1428 */
1429 Tags?: TagList;
1430 }
1431 export interface CreateDBClusterSnapshotResult {
1432 DBClusterSnapshot?: DBClusterSnapshot;
1433 }
1434 export interface CreateDBInstanceMessage {
1435 /**
1436 * 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 letters or numbers. Can't 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 letters or numbers. Can't 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 letters, numbers, or underscores. Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName. Default: ORCL Constraints: Can't 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 letters or numbers. Can't be a word reserved by the specified database engine
1437 */
1438 DBName?: String;
1439 /**
1440 * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
1441 */
1442 DBInstanceIdentifier: String;
1443 /**
1444 * The amount of storage (in gibibytes) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. MySQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to 1024. Web and Express editions: Must be an integer from 20 to 1024.
1445 */
1446 AllocatedStorage?: IntegerOptional;
1447 /**
1448 * The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
1449 */
1450 DBInstanceClass: String;
1451 /**
1452 * The name of the database engine to be used for this instance. Not every database engine is available for every AWS Region. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
1453 */
1454 Engine: String;
1455 /**
1456 * The name for the master user. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster. MariaDB Constraints: Required for MariaDB. Must be 1 to 16 letters or numbers. Can't be a reserved word for the chosen database engine. Microsoft SQL Server Constraints: Required for SQL Server. Must be 1 to 128 letters or numbers. The first character must be a letter. Can't be a reserved word for the chosen database engine. MySQL Constraints: Required for MySQL. Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. Oracle Constraints: Required for Oracle. Must be 1 to 30 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. PostgreSQL Constraints: Required for PostgreSQL. Must be 1 to 63 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
1457 */
1458 MasterUsername?: String;
1459 /**
1460 * The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster. MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters.
1461 */
1462 MasterUserPassword?: String;
1463 /**
1464 * A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
1465 */
1466 DBSecurityGroups?: DBSecurityGroupNameList;
1467 /**
1468 * A list of Amazon EC2 VPC security groups to associate with this DB instance. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster. Default: The default EC2 VPC security group for the DB subnet group's VPC.
1469 */
1470 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1471 /**
1472 * The EC2 Availability Zone that the DB instance is created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.
1473 */
1474 AvailabilityZone?: String;
1475 /**
1476 * 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.
1477 */
1478 DBSubnetGroupName?: String;
1479 /**
1480 * The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window. Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
1481 */
1482 PreferredMaintenanceWindow?: String;
1483 /**
1484 * 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 is used. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
1485 */
1486 DBParameterGroupName?: String;
1487 /**
1488 * 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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster. Default: 1 Constraints: Must be a value from 0 to 35 Can't be set to 0 if the DB instance is a source to Read Replicas
1489 */
1490 BackupRetentionPeriod?: IntegerOptional;
1491 /**
1492 * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
1493 */
1494 PreferredBackupWindow?: String;
1495 /**
1496 * 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
1497 */
1498 Port?: IntegerOptional;
1499 /**
1500 * A value that specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
1501 */
1502 MultiAZ?: BooleanOptional;
1503 /**
1504 * The version number of the database engine to use. For a list of valid engine versions, call DescribeDBEngineVersions. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
1505 */
1506 EngineVersion?: String;
1507 /**
1508 * Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true
1509 */
1510 AutoMinorVersionUpgrade?: BooleanOptional;
1511 /**
1512 * License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license
1513 */
1514 LicenseModel?: String;
1515 /**
1516 * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.
1517 */
1518 Iops?: IntegerOptional;
1519 /**
1520 * 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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
1521 */
1522 OptionGroupName?: String;
1523 /**
1524 * For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
1525 */
1526 CharacterSetName?: String;
1527 /**
1528 * 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 DBSubnetGroupName is specified. If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the following applies: If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private. If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public. If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the following applies: If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private. If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
1529 */
1530 PubliclyAccessible?: BooleanOptional;
1531 Tags?: TagList;
1532 /**
1533 * The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String
1534 */
1535 DBClusterIdentifier?: String;
1536 /**
1537 * 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
1538 */
1539 StorageType?: String;
1540 /**
1541 * The ARN from the key store with which to associate the instance for TDE encryption.
1542 */
1543 TdeCredentialArn?: String;
1544 /**
1545 * The password for the given ARN from the key store in order to access the device.
1546 */
1547 TdeCredentialPassword?: String;
1548 /**
1549 * Specifies whether the DB instance is encrypted. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster. Default: false
1550 */
1551 StorageEncrypted?: BooleanOptional;
1552 /**
1553 * The AWS 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. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster. 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.
1554 */
1555 KmsKeyId?: String;
1556 /**
1557 * Specify the Active Directory Domain to create the instance in.
1558 */
1559 Domain?: String;
1560 /**
1561 * True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see CreateDBCluster.
1562 */
1563 CopyTagsToSnapshot?: BooleanOptional;
1564 /**
1565 * 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
1566 */
1567 MonitoringInterval?: IntegerOptional;
1568 /**
1569 * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
1570 */
1571 MonitoringRoleArn?: String;
1572 /**
1573 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
1574 */
1575 DomainIAMRoleName?: String;
1576 /**
1577 * 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 in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15
1578 */
1579 PromotionTier?: IntegerOptional;
1580 /**
1581 * The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
1582 */
1583 Timezone?: String;
1584 /**
1585 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines: Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster. MySQL For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Default: false
1586 */
1587 EnableIAMDatabaseAuthentication?: BooleanOptional;
1588 /**
1589 * True to enable Performance Insights for the DB instance, and otherwise false. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
1590 */
1591 EnablePerformanceInsights?: BooleanOptional;
1592 /**
1593 * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
1594 */
1595 PerformanceInsightsKMSKeyId?: String;
1596 /**
1597 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
1598 */
1599 PerformanceInsightsRetentionPeriod?: IntegerOptional;
1600 /**
1601 * The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.
1602 */
1603 EnableCloudwatchLogsExports?: LogTypeList;
1604 /**
1605 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
1606 */
1607 ProcessorFeatures?: ProcessorFeatureList;
1608 /**
1609 * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.
1610 */
1611 DeletionProtection?: BooleanOptional;
1612 }
1613 export interface CreateDBInstanceReadReplicaMessage {
1614 /**
1615 * 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.
1616 */
1617 DBInstanceIdentifier: String;
1618 /**
1619 * 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 or later. Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication). 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 AWS Region as the Read Replica, specify a valid DB instance identifier. If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
1620 */
1621 SourceDBInstanceIdentifier: String;
1622 /**
1623 * The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: Inherits from the source DB instance.
1624 */
1625 DBInstanceClass?: String;
1626 /**
1627 * The Amazon EC2 Availability Zone that the Read Replica is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d
1628 */
1629 AvailabilityZone?: String;
1630 /**
1631 * The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535
1632 */
1633 Port?: IntegerOptional;
1634 /**
1635 * Specifies whether the Read Replica is in a Multi-AZ deployment. You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
1636 */
1637 MultiAZ?: BooleanOptional;
1638 /**
1639 * Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance
1640 */
1641 AutoMinorVersionUpgrade?: BooleanOptional;
1642 /**
1643 * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
1644 */
1645 Iops?: IntegerOptional;
1646 /**
1647 * The option group the DB instance is associated with. If omitted, the default option group for the engine specified is used.
1648 */
1649 OptionGroupName?: String;
1650 /**
1651 * 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. For more information, see CreateDBInstance.
1652 */
1653 PubliclyAccessible?: BooleanOptional;
1654 Tags?: TagList;
1655 /**
1656 * Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC. Constraints: Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region. If supplied, must match the name of an existing DBSubnetGroup. The specified DB subnet group must be in the same AWS Region in which the operation is running. All Read Replicas in one AWS Region that are created from the same source DB instance must either:&gt; Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC. Not specify a DB subnet group. All these Read Replicas are created outside of any VPC. Example: mySubnetgroup
1657 */
1658 DBSubnetGroupName?: String;
1659 /**
1660 * A list of EC2 VPC security groups to associate with the Read Replica. Default: The default EC2 VPC security group for the DB subnet group's VPC.
1661 */
1662 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1663 /**
1664 * 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
1665 */
1666 StorageType?: String;
1667 /**
1668 * True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.
1669 */
1670 CopyTagsToSnapshot?: BooleanOptional;
1671 /**
1672 * 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
1673 */
1674 MonitoringInterval?: IntegerOptional;
1675 /**
1676 * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon 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 in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
1677 */
1678 MonitoringRoleArn?: String;
1679 /**
1680 * The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance. If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. You can't create an encrypted Read Replica from an unencrypted DB instance.
1681 */
1682 KmsKeyId?: String;
1683 /**
1684 * The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance. You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI. The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
1685 */
1686 PreSignedUrl?: String;
1687 /**
1688 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Aurora MySQL 5.6 or higher Default: false
1689 */
1690 EnableIAMDatabaseAuthentication?: BooleanOptional;
1691 /**
1692 * True to enable Performance Insights for the read replica, and otherwise false. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
1693 */
1694 EnablePerformanceInsights?: BooleanOptional;
1695 /**
1696 * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
1697 */
1698 PerformanceInsightsKMSKeyId?: String;
1699 /**
1700 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
1701 */
1702 PerformanceInsightsRetentionPeriod?: IntegerOptional;
1703 /**
1704 * The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
1705 */
1706 EnableCloudwatchLogsExports?: LogTypeList;
1707 /**
1708 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
1709 */
1710 ProcessorFeatures?: ProcessorFeatureList;
1711 /**
1712 * A value that specifies that the DB instance class of the DB instance uses its default processor features.
1713 */
1714 UseDefaultProcessorFeatures?: BooleanOptional;
1715 /**
1716 * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.
1717 */
1718 DeletionProtection?: BooleanOptional;
1719 /**
1720 * The ID of the region that contains the source for the read replica.
1721 */
1722 SourceRegion?: String;
1723 }
1724 export interface CreateDBInstanceReadReplicaResult {
1725 DBInstance?: DBInstance;
1726 }
1727 export interface CreateDBInstanceResult {
1728 DBInstance?: DBInstance;
1729 }
1730 export interface CreateDBParameterGroupMessage {
1731 /**
1732 * The name of the DB parameter group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
1733 */
1734 DBParameterGroupName: String;
1735 /**
1736 * 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. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates.
1737 */
1738 DBParameterGroupFamily: String;
1739 /**
1740 * The description for the DB parameter group.
1741 */
1742 Description: String;
1743 Tags?: TagList;
1744 }
1745 export interface CreateDBParameterGroupResult {
1746 DBParameterGroup?: DBParameterGroup;
1747 }
1748 export interface CreateDBSecurityGroupMessage {
1749 /**
1750 * The name for the DB security group. This value is stored as a lowercase string. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Must not be "Default" Example: mysecuritygroup
1751 */
1752 DBSecurityGroupName: String;
1753 /**
1754 * The description for the DB security group.
1755 */
1756 DBSecurityGroupDescription: String;
1757 Tags?: TagList;
1758 }
1759 export interface CreateDBSecurityGroupResult {
1760 DBSecurityGroup?: DBSecurityGroup;
1761 }
1762 export interface CreateDBSnapshotMessage {
1763 /**
1764 * The identifier for the DB snapshot. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
1765 */
1766 DBSnapshotIdentifier: String;
1767 /**
1768 * The identifier of the DB instance that you want to create the snapshot of. Constraints: Must match the identifier of an existing DBInstance.
1769 */
1770 DBInstanceIdentifier: String;
1771 Tags?: TagList;
1772 }
1773 export interface CreateDBSnapshotResult {
1774 DBSnapshot?: DBSnapshot;
1775 }
1776 export interface CreateDBSubnetGroupMessage {
1777 /**
1778 * The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
1779 */
1780 DBSubnetGroupName: String;
1781 /**
1782 * The description for the DB subnet group.
1783 */
1784 DBSubnetGroupDescription: String;
1785 /**
1786 * The EC2 Subnet IDs for the DB subnet group.
1787 */
1788 SubnetIds: SubnetIdentifierList;
1789 Tags?: TagList;
1790 }
1791 export interface CreateDBSubnetGroupResult {
1792 DBSubnetGroup?: DBSubnetGroup;
1793 }
1794 export interface CreateEventSubscriptionMessage {
1795 /**
1796 * The name of the subscription. Constraints: The name must be less than 255 characters.
1797 */
1798 SubscriptionName: String;
1799 /**
1800 * 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.
1801 */
1802 SnsTopicArn: String;
1803 /**
1804 * The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. 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
1805 */
1806 SourceType?: String;
1807 /**
1808 * 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.
1809 */
1810 EventCategories?: EventCategoriesList;
1811 /**
1812 * The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds are 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.
1813 */
1814 SourceIds?: SourceIdsList;
1815 /**
1816 * A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
1817 */
1818 Enabled?: BooleanOptional;
1819 Tags?: TagList;
1820 }
1821 export interface CreateEventSubscriptionResult {
1822 EventSubscription?: EventSubscription;
1823 }
1824 export interface CreateGlobalClusterMessage {
1825 /**
1826 * The cluster identifier of the new global database cluster.
1827 */
1828 GlobalClusterIdentifier?: String;
1829 /**
1830 * The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.
1831 */
1832 SourceDBClusterIdentifier?: String;
1833 /**
1834 * Provides the name of the database engine to be used for this DB cluster.
1835 */
1836 Engine?: String;
1837 /**
1838 * The engine version of the Aurora global database.
1839 */
1840 EngineVersion?: String;
1841 /**
1842 * The deletion protection setting for the new global database. The global database can't be deleted when this value is set to true.
1843 */
1844 DeletionProtection?: BooleanOptional;
1845 /**
1846 * The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.
1847 */
1848 DatabaseName?: String;
1849 /**
1850 * The storage encryption setting for the new global database cluster.
1851 */
1852 StorageEncrypted?: BooleanOptional;
1853 }
1854 export interface CreateGlobalClusterResult {
1855 GlobalCluster?: GlobalCluster;
1856 }
1857 export interface CreateOptionGroupMessage {
1858 /**
1859 * Specifies the name of the option group to be created. Constraints: Must be 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: myoptiongroup
1860 */
1861 OptionGroupName: String;
1862 /**
1863 * Specifies the name of the engine that this option group should be associated with.
1864 */
1865 EngineName: String;
1866 /**
1867 * Specifies the major version of the engine that this option group should be associated with.
1868 */
1869 MajorEngineVersion: String;
1870 /**
1871 * The description of the option group.
1872 */
1873 OptionGroupDescription: String;
1874 Tags?: TagList;
1875 }
1876 export interface CreateOptionGroupResult {
1877 OptionGroup?: OptionGroup;
1878 }
1879 export interface DBCluster {
1880 /**
1881 * For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.
1882 */
1883 AllocatedStorage?: IntegerOptional;
1884 /**
1885 * Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
1886 */
1887 AvailabilityZones?: AvailabilityZones;
1888 /**
1889 * Specifies the number of days for which automatic DB snapshots are retained.
1890 */
1891 BackupRetentionPeriod?: IntegerOptional;
1892 /**
1893 * If present, specifies the name of the character set that this cluster is associated with.
1894 */
1895 CharacterSetName?: String;
1896 /**
1897 * 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.
1898 */
1899 DatabaseName?: String;
1900 /**
1901 * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
1902 */
1903 DBClusterIdentifier?: String;
1904 /**
1905 * Specifies the name of the DB cluster parameter group for the DB cluster.
1906 */
1907 DBClusterParameterGroup?: String;
1908 /**
1909 * Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
1910 */
1911 DBSubnetGroup?: String;
1912 /**
1913 * Specifies the current state of this DB cluster.
1914 */
1915 Status?: String;
1916 /**
1917 * Specifies the progress of the operation as a percentage.
1918 */
1919 PercentProgress?: String;
1920 /**
1921 * The earliest time to which a database can be restored with point-in-time restore.
1922 */
1923 EarliestRestorableTime?: TStamp;
1924 /**
1925 * Specifies the connection endpoint for the primary instance of the DB cluster.
1926 */
1927 Endpoint?: String;
1928 /**
1929 * 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 is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
1930 */
1931 ReaderEndpoint?: String;
1932 /**
1933 * Identifies all custom endpoints associated with the cluster.
1934 */
1935 CustomEndpoints?: StringList;
1936 /**
1937 * Specifies whether the DB cluster has instances in multiple Availability Zones.
1938 */
1939 MultiAZ?: Boolean;
1940 /**
1941 * Provides the name of the database engine to be used for this DB cluster.
1942 */
1943 Engine?: String;
1944 /**
1945 * Indicates the database engine version.
1946 */
1947 EngineVersion?: String;
1948 /**
1949 * Specifies the latest time to which a database can be restored with point-in-time restore.
1950 */
1951 LatestRestorableTime?: TStamp;
1952 /**
1953 * Specifies the port that the database engine is listening on.
1954 */
1955 Port?: IntegerOptional;
1956 /**
1957 * Contains the master username for the DB cluster.
1958 */
1959 MasterUsername?: String;
1960 /**
1961 * Provides the list of option group memberships for this DB cluster.
1962 */
1963 DBClusterOptionGroupMemberships?: DBClusterOptionGroupMemberships;
1964 /**
1965 * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
1966 */
1967 PreferredBackupWindow?: String;
1968 /**
1969 * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
1970 */
1971 PreferredMaintenanceWindow?: String;
1972 /**
1973 * Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
1974 */
1975 ReplicationSourceIdentifier?: String;
1976 /**
1977 * Contains one or more identifiers of the Read Replicas associated with this DB cluster.
1978 */
1979 ReadReplicaIdentifiers?: ReadReplicaIdentifierList;
1980 /**
1981 * Provides the list of instances that make up the DB cluster.
1982 */
1983 DBClusterMembers?: DBClusterMemberList;
1984 /**
1985 * Provides a list of VPC security groups that the DB cluster belongs to.
1986 */
1987 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
1988 /**
1989 * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
1990 */
1991 HostedZoneId?: String;
1992 /**
1993 * Specifies whether the DB cluster is encrypted.
1994 */
1995 StorageEncrypted?: Boolean;
1996 /**
1997 * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
1998 */
1999 KmsKeyId?: String;
2000 /**
2001 * The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
2002 */
2003 DbClusterResourceId?: String;
2004 /**
2005 * The Amazon Resource Name (ARN) for the DB cluster.
2006 */
2007 DBClusterArn?: String;
2008 /**
2009 * 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.
2010 */
2011 AssociatedRoles?: DBClusterRoles;
2012 /**
2013 * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
2014 */
2015 IAMDatabaseAuthenticationEnabled?: Boolean;
2016 /**
2017 * Identifies the clone group to which the DB cluster is associated.
2018 */
2019 CloneGroupId?: String;
2020 /**
2021 * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
2022 */
2023 ClusterCreateTime?: TStamp;
2024 /**
2025 * The earliest time to which a DB cluster can be backtracked.
2026 */
2027 EarliestBacktrackTime?: TStamp;
2028 /**
2029 * The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
2030 */
2031 BacktrackWindow?: LongOptional;
2032 /**
2033 * The number of change records stored for Backtrack.
2034 */
2035 BacktrackConsumedChangeRecords?: LongOptional;
2036 /**
2037 * A list of log types that this DB cluster is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
2038 */
2039 EnabledCloudwatchLogsExports?: LogTypeList;
2040 /**
2041 * The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
2042 */
2043 Capacity?: IntegerOptional;
2044 /**
2045 * The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
2046 */
2047 EngineMode?: String;
2048 ScalingConfigurationInfo?: ScalingConfigurationInfo;
2049 /**
2050 * Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
2051 */
2052 DeletionProtection?: Boolean;
2053 /**
2054 * HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change. Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
2055 */
2056 HttpEndpointEnabled?: Boolean;
2057 /**
2058 * Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
2059 */
2060 CopyTagsToSnapshot?: Boolean;
2061 }
2062 export interface DBClusterBacktrack {
2063 /**
2064 * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
2065 */
2066 DBClusterIdentifier?: String;
2067 /**
2068 * Contains the backtrack identifier.
2069 */
2070 BacktrackIdentifier?: String;
2071 /**
2072 * The timestamp of the time to which the DB cluster was backtracked.
2073 */
2074 BacktrackTo?: TStamp;
2075 /**
2076 * The timestamp of the time from which the DB cluster was backtracked.
2077 */
2078 BacktrackedFrom?: TStamp;
2079 /**
2080 * The timestamp of the time at which the backtrack was requested.
2081 */
2082 BacktrackRequestCreationTime?: TStamp;
2083 /**
2084 * The status of the backtrack. This property returns one of the following values: applying - The backtrack is currently being applied to or rolled back from the DB cluster. completed - The backtrack has successfully been applied to or rolled back from the DB cluster. failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster. pending - The backtrack is currently pending application to or rollback from the DB cluster.
2085 */
2086 Status?: String;
2087 }
2088 export type DBClusterBacktrackList = DBClusterBacktrack[];
2089 export interface DBClusterBacktrackMessage {
2090 /**
2091 * A pagination token that can be used in a subsequent DescribeDBClusterBacktracks request.
2092 */
2093 Marker?: String;
2094 /**
2095 * Contains a list of backtracks for the user.
2096 */
2097 DBClusterBacktracks?: DBClusterBacktrackList;
2098 }
2099 export interface DBClusterCapacityInfo {
2100 /**
2101 * A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
2102 */
2103 DBClusterIdentifier?: String;
2104 /**
2105 * A value that specifies the capacity that the DB cluster scales to next.
2106 */
2107 PendingCapacity?: IntegerOptional;
2108 /**
2109 * The current capacity of the DB cluster.
2110 */
2111 CurrentCapacity?: IntegerOptional;
2112 /**
2113 * The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
2114 */
2115 SecondsBeforeTimeout?: IntegerOptional;
2116 /**
2117 * The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
2118 */
2119 TimeoutAction?: String;
2120 }
2121 export interface DBClusterEndpoint {
2122 /**
2123 * The identifier associated with the endpoint. This parameter is stored as a lowercase string.
2124 */
2125 DBClusterEndpointIdentifier?: String;
2126 /**
2127 * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
2128 */
2129 DBClusterIdentifier?: String;
2130 /**
2131 * A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
2132 */
2133 DBClusterEndpointResourceIdentifier?: String;
2134 /**
2135 * The DNS address of the endpoint.
2136 */
2137 Endpoint?: String;
2138 /**
2139 * The current status of the endpoint. One of: creating, available, deleting, modifying.
2140 */
2141 Status?: String;
2142 /**
2143 * The type of the endpoint. One of: READER, WRITER, CUSTOM.
2144 */
2145 EndpointType?: String;
2146 /**
2147 * The type associated with a custom endpoint. One of: READER, ANY.
2148 */
2149 CustomEndpointType?: String;
2150 /**
2151 * List of DB instance identifiers that are part of the custom endpoint group.
2152 */
2153 StaticMembers?: StringList;
2154 /**
2155 * List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
2156 */
2157 ExcludedMembers?: StringList;
2158 /**
2159 * The Amazon Resource Name (ARN) for the endpoint.
2160 */
2161 DBClusterEndpointArn?: String;
2162 }
2163 export type DBClusterEndpointList = DBClusterEndpoint[];
2164 export interface DBClusterEndpointMessage {
2165 /**
2166 * An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2167 */
2168 Marker?: String;
2169 /**
2170 * Contains the details of the endpoints associated with the cluster and matching any filter conditions.
2171 */
2172 DBClusterEndpoints?: DBClusterEndpointList;
2173 }
2174 export type DBClusterList = DBCluster[];
2175 export interface DBClusterMember {
2176 /**
2177 * Specifies the instance identifier for this member of the DB cluster.
2178 */
2179 DBInstanceIdentifier?: String;
2180 /**
2181 * Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
2182 */
2183 IsClusterWriter?: Boolean;
2184 /**
2185 * Specifies the status of the DB cluster parameter group for this member of the DB cluster.
2186 */
2187 DBClusterParameterGroupStatus?: String;
2188 /**
2189 * 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 in the Amazon Aurora User Guide.
2190 */
2191 PromotionTier?: IntegerOptional;
2192 }
2193 export type DBClusterMemberList = DBClusterMember[];
2194 export interface DBClusterMessage {
2195 /**
2196 * A pagination token that can be used in a subsequent DescribeDBClusters request.
2197 */
2198 Marker?: String;
2199 /**
2200 * Contains a list of DB clusters for the user.
2201 */
2202 DBClusters?: DBClusterList;
2203 }
2204 export type DBClusterOptionGroupMemberships = DBClusterOptionGroupStatus[];
2205 export interface DBClusterOptionGroupStatus {
2206 /**
2207 * Specifies the name of the DB cluster option group.
2208 */
2209 DBClusterOptionGroupName?: String;
2210 /**
2211 * Specifies the status of the DB cluster option group.
2212 */
2213 Status?: String;
2214 }
2215 export interface DBClusterParameterGroup {
2216 /**
2217 * Provides the name of the DB cluster parameter group.
2218 */
2219 DBClusterParameterGroupName?: String;
2220 /**
2221 * Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
2222 */
2223 DBParameterGroupFamily?: String;
2224 /**
2225 * Provides the customer-specified description for this DB cluster parameter group.
2226 */
2227 Description?: String;
2228 /**
2229 * The Amazon Resource Name (ARN) for the DB cluster parameter group.
2230 */
2231 DBClusterParameterGroupArn?: String;
2232 }
2233 export interface DBClusterParameterGroupDetails {
2234 /**
2235 * Provides a list of parameters for the DB cluster parameter group.
2236 */
2237 Parameters?: ParametersList;
2238 /**
2239 * 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 .
2240 */
2241 Marker?: String;
2242 }
2243 export type DBClusterParameterGroupList = DBClusterParameterGroup[];
2244 export interface DBClusterParameterGroupNameMessage {
2245 /**
2246 * The name of the DB cluster parameter group. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
2247 */
2248 DBClusterParameterGroupName?: String;
2249 }
2250 export interface DBClusterParameterGroupsMessage {
2251 /**
2252 * 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.
2253 */
2254 Marker?: String;
2255 /**
2256 * A list of DB cluster parameter groups.
2257 */
2258 DBClusterParameterGroups?: DBClusterParameterGroupList;
2259 }
2260 export interface DBClusterRole {
2261 /**
2262 * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
2263 */
2264 RoleArn?: String;
2265 /**
2266 * 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.
2267 */
2268 Status?: String;
2269 FeatureName?: String;
2270 }
2271 export type DBClusterRoles = DBClusterRole[];
2272 export interface DBClusterSnapshot {
2273 /**
2274 * Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
2275 */
2276 AvailabilityZones?: AvailabilityZones;
2277 /**
2278 * Specifies the identifier for the DB cluster snapshot.
2279 */
2280 DBClusterSnapshotIdentifier?: String;
2281 /**
2282 * Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
2283 */
2284 DBClusterIdentifier?: String;
2285 /**
2286 * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
2287 */
2288 SnapshotCreateTime?: TStamp;
2289 /**
2290 * Specifies the name of the database engine.
2291 */
2292 Engine?: String;
2293 /**
2294 * Specifies the allocated storage size in gibibytes (GiB).
2295 */
2296 AllocatedStorage?: Integer;
2297 /**
2298 * Specifies the status of this DB cluster snapshot.
2299 */
2300 Status?: String;
2301 /**
2302 * Specifies the port that the DB cluster was listening on at the time of the snapshot.
2303 */
2304 Port?: Integer;
2305 /**
2306 * Provides the VPC ID associated with the DB cluster snapshot.
2307 */
2308 VpcId?: String;
2309 /**
2310 * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
2311 */
2312 ClusterCreateTime?: TStamp;
2313 /**
2314 * Provides the master username for the DB cluster snapshot.
2315 */
2316 MasterUsername?: String;
2317 /**
2318 * Provides the version of the database engine for this DB cluster snapshot.
2319 */
2320 EngineVersion?: String;
2321 /**
2322 * Provides the license model information for this DB cluster snapshot.
2323 */
2324 LicenseModel?: String;
2325 /**
2326 * Provides the type of the DB cluster snapshot.
2327 */
2328 SnapshotType?: String;
2329 /**
2330 * Specifies the percentage of the estimated data that has been transferred.
2331 */
2332 PercentProgress?: Integer;
2333 /**
2334 * Specifies whether the DB cluster snapshot is encrypted.
2335 */
2336 StorageEncrypted?: Boolean;
2337 /**
2338 * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
2339 */
2340 KmsKeyId?: String;
2341 /**
2342 * The Amazon Resource Name (ARN) for the DB cluster snapshot.
2343 */
2344 DBClusterSnapshotArn?: String;
2345 /**
2346 * If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
2347 */
2348 SourceDBClusterSnapshotArn?: String;
2349 /**
2350 * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
2351 */
2352 IAMDatabaseAuthenticationEnabled?: Boolean;
2353 }
2354 export interface DBClusterSnapshotAttribute {
2355 /**
2356 * 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.
2357 */
2358 AttributeName?: String;
2359 /**
2360 * 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.
2361 */
2362 AttributeValues?: AttributeValueList;
2363 }
2364 export type DBClusterSnapshotAttributeList = DBClusterSnapshotAttribute[];
2365 export interface DBClusterSnapshotAttributesResult {
2366 /**
2367 * The identifier of the manual DB cluster snapshot that the attributes apply to.
2368 */
2369 DBClusterSnapshotIdentifier?: String;
2370 /**
2371 * The list of attributes and values for the manual DB cluster snapshot.
2372 */
2373 DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList;
2374 }
2375 export type DBClusterSnapshotList = DBClusterSnapshot[];
2376 export interface DBClusterSnapshotMessage {
2377 /**
2378 * 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.
2379 */
2380 Marker?: String;
2381 /**
2382 * Provides a list of DB cluster snapshots for the user.
2383 */
2384 DBClusterSnapshots?: DBClusterSnapshotList;
2385 }
2386 export interface DBEngineVersion {
2387 /**
2388 * The name of the database engine.
2389 */
2390 Engine?: String;
2391 /**
2392 * The version number of the database engine.
2393 */
2394 EngineVersion?: String;
2395 /**
2396 * The name of the DB parameter group family for the database engine.
2397 */
2398 DBParameterGroupFamily?: String;
2399 /**
2400 * The description of the database engine.
2401 */
2402 DBEngineDescription?: String;
2403 /**
2404 * The description of the database engine version.
2405 */
2406 DBEngineVersionDescription?: String;
2407 /**
2408 * The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
2409 */
2410 DefaultCharacterSet?: CharacterSet;
2411 /**
2412 * A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.
2413 */
2414 SupportedCharacterSets?: SupportedCharacterSetsList;
2415 /**
2416 * A list of engine versions that this database engine version can be upgraded to.
2417 */
2418 ValidUpgradeTarget?: ValidUpgradeTargetList;
2419 /**
2420 * A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
2421 */
2422 SupportedTimezones?: SupportedTimezonesList;
2423 /**
2424 * The types of logs that the database engine has available for export to CloudWatch Logs.
2425 */
2426 ExportableLogTypes?: LogTypeList;
2427 /**
2428 * A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
2429 */
2430 SupportsLogExportsToCloudwatchLogs?: Boolean;
2431 /**
2432 * Indicates whether the database engine version supports read replicas.
2433 */
2434 SupportsReadReplica?: Boolean;
2435 /**
2436 * A list of the supported DB engine modes.
2437 */
2438 SupportedEngineModes?: EngineModeList;
2439 /**
2440 * A list of features supported by the DB engine. Supported feature names include the following. s3Import
2441 */
2442 SupportedFeatureNames?: FeatureNameList;
2443 }
2444 export type DBEngineVersionList = DBEngineVersion[];
2445 export interface DBEngineVersionMessage {
2446 /**
2447 * 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.
2448 */
2449 Marker?: String;
2450 /**
2451 * A list of DBEngineVersion elements.
2452 */
2453 DBEngineVersions?: DBEngineVersionList;
2454 }
2455 export interface DBInstance {
2456 /**
2457 * Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
2458 */
2459 DBInstanceIdentifier?: String;
2460 /**
2461 * Contains the name of the compute and memory capacity class of the DB instance.
2462 */
2463 DBInstanceClass?: String;
2464 /**
2465 * Provides the name of the database engine to be used for this DB instance.
2466 */
2467 Engine?: String;
2468 /**
2469 * Specifies the current state of this database.
2470 */
2471 DBInstanceStatus?: String;
2472 /**
2473 * Contains the master username for the DB instance.
2474 */
2475 MasterUsername?: String;
2476 /**
2477 * 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 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.
2478 */
2479 DBName?: String;
2480 /**
2481 * Specifies the connection endpoint.
2482 */
2483 Endpoint?: Endpoint;
2484 /**
2485 * Specifies the allocated storage size specified in gibibytes.
2486 */
2487 AllocatedStorage?: Integer;
2488 /**
2489 * Provides the date and time the DB instance was created.
2490 */
2491 InstanceCreateTime?: TStamp;
2492 /**
2493 * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
2494 */
2495 PreferredBackupWindow?: String;
2496 /**
2497 * Specifies the number of days for which automatic DB snapshots are retained.
2498 */
2499 BackupRetentionPeriod?: Integer;
2500 /**
2501 * Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
2502 */
2503 DBSecurityGroups?: DBSecurityGroupMembershipList;
2504 /**
2505 * Provides a list of VPC security group elements that the DB instance belongs to.
2506 */
2507 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
2508 /**
2509 * Provides the list of DB parameter groups applied to this DB instance.
2510 */
2511 DBParameterGroups?: DBParameterGroupStatusList;
2512 /**
2513 * Specifies the name of the Availability Zone the DB instance is located in.
2514 */
2515 AvailabilityZone?: String;
2516 /**
2517 * Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
2518 */
2519 DBSubnetGroup?: DBSubnetGroup;
2520 /**
2521 * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
2522 */
2523 PreferredMaintenanceWindow?: String;
2524 /**
2525 * Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
2526 */
2527 PendingModifiedValues?: PendingModifiedValues;
2528 /**
2529 * Specifies the latest time to which a database can be restored with point-in-time restore.
2530 */
2531 LatestRestorableTime?: TStamp;
2532 /**
2533 * Specifies if the DB instance is a Multi-AZ deployment.
2534 */
2535 MultiAZ?: Boolean;
2536 /**
2537 * Indicates the database engine version.
2538 */
2539 EngineVersion?: String;
2540 /**
2541 * Indicates that minor version patches are applied automatically.
2542 */
2543 AutoMinorVersionUpgrade?: Boolean;
2544 /**
2545 * Contains the identifier of the source DB instance if this DB instance is a Read Replica.
2546 */
2547 ReadReplicaSourceDBInstanceIdentifier?: String;
2548 /**
2549 * Contains one or more identifiers of the Read Replicas associated with this DB instance.
2550 */
2551 ReadReplicaDBInstanceIdentifiers?: ReadReplicaDBInstanceIdentifierList;
2552 /**
2553 * Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas. Currently, each RDS DB instance can have only one Aurora Read Replica.
2554 */
2555 ReadReplicaDBClusterIdentifiers?: ReadReplicaDBClusterIdentifierList;
2556 /**
2557 * License model information for this DB instance.
2558 */
2559 LicenseModel?: String;
2560 /**
2561 * Specifies the Provisioned IOPS (I/O operations per second) value.
2562 */
2563 Iops?: IntegerOptional;
2564 /**
2565 * Provides the list of option group memberships for this DB instance.
2566 */
2567 OptionGroupMemberships?: OptionGroupMembershipList;
2568 /**
2569 * If present, specifies the name of the character set that this instance is associated with.
2570 */
2571 CharacterSetName?: String;
2572 /**
2573 * If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
2574 */
2575 SecondaryAvailabilityZone?: String;
2576 /**
2577 * 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.
2578 */
2579 PubliclyAccessible?: Boolean;
2580 /**
2581 * The status of a Read Replica. If the instance is not a Read Replica, this is blank.
2582 */
2583 StatusInfos?: DBInstanceStatusInfoList;
2584 /**
2585 * Specifies the storage type associated with DB instance.
2586 */
2587 StorageType?: String;
2588 /**
2589 * The ARN from the key store with which the instance is associated for TDE encryption.
2590 */
2591 TdeCredentialArn?: String;
2592 /**
2593 * 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.
2594 */
2595 DbInstancePort?: Integer;
2596 /**
2597 * 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.
2598 */
2599 DBClusterIdentifier?: String;
2600 /**
2601 * Specifies whether the DB instance is encrypted.
2602 */
2603 StorageEncrypted?: Boolean;
2604 /**
2605 * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
2606 */
2607 KmsKeyId?: String;
2608 /**
2609 * The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
2610 */
2611 DbiResourceId?: String;
2612 /**
2613 * The identifier of the CA certificate for this DB instance.
2614 */
2615 CACertificateIdentifier?: String;
2616 /**
2617 * The Active Directory Domain membership records associated with the DB instance.
2618 */
2619 DomainMemberships?: DomainMembershipList;
2620 /**
2621 * Specifies whether tags are copied from the DB instance to snapshots of the DB instance. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
2622 */
2623 CopyTagsToSnapshot?: Boolean;
2624 /**
2625 * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
2626 */
2627 MonitoringInterval?: IntegerOptional;
2628 /**
2629 * The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
2630 */
2631 EnhancedMonitoringResourceArn?: String;
2632 /**
2633 * The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
2634 */
2635 MonitoringRoleArn?: String;
2636 /**
2637 * 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 in the Amazon Aurora User Guide.
2638 */
2639 PromotionTier?: IntegerOptional;
2640 /**
2641 * The Amazon Resource Name (ARN) for the DB instance.
2642 */
2643 DBInstanceArn?: String;
2644 /**
2645 * 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.
2646 */
2647 Timezone?: String;
2648 /**
2649 * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. IAM database authentication can be enabled for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
2650 */
2651 IAMDatabaseAuthenticationEnabled?: Boolean;
2652 /**
2653 * True if Performance Insights is enabled for the DB instance, and otherwise false.
2654 */
2655 PerformanceInsightsEnabled?: BooleanOptional;
2656 /**
2657 * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
2658 */
2659 PerformanceInsightsKMSKeyId?: String;
2660 /**
2661 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
2662 */
2663 PerformanceInsightsRetentionPeriod?: IntegerOptional;
2664 /**
2665 * A list of log types that this DB instance is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
2666 */
2667 EnabledCloudwatchLogsExports?: LogTypeList;
2668 /**
2669 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
2670 */
2671 ProcessorFeatures?: ProcessorFeatureList;
2672 /**
2673 * Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.
2674 */
2675 DeletionProtection?: Boolean;
2676 /**
2677 * The AWS Identity and Access Management (IAM) roles associated with the DB instance.
2678 */
2679 AssociatedRoles?: DBInstanceRoles;
2680 /**
2681 * Specifies the listener connection endpoint for SQL Server Always On.
2682 */
2683 ListenerEndpoint?: Endpoint;
2684 }
2685 export interface DBInstanceAutomatedBackup {
2686 /**
2687 * The Amazon Resource Name (ARN) for the automated backup.
2688 */
2689 DBInstanceArn?: String;
2690 /**
2691 * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
2692 */
2693 DbiResourceId?: String;
2694 /**
2695 * The AWS Region associated with the automated backup.
2696 */
2697 Region?: String;
2698 /**
2699 * The customer id of the instance that is/was associated with the automated backup.
2700 */
2701 DBInstanceIdentifier?: String;
2702 /**
2703 * Earliest and latest time an instance can be restored to.
2704 */
2705 RestoreWindow?: RestoreWindow;
2706 /**
2707 * Specifies the allocated storage size in gibibytes (GiB).
2708 */
2709 AllocatedStorage?: Integer;
2710 /**
2711 * Provides a list of status information for an automated backup: active - automated backups for current instances retained - automated backups for deleted instances creating - automated backups that are waiting for the first automated snapshot to be available.
2712 */
2713 Status?: String;
2714 /**
2715 * The port number that the automated backup used for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535
2716 */
2717 Port?: Integer;
2718 /**
2719 * The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
2720 */
2721 AvailabilityZone?: String;
2722 /**
2723 * Provides the VPC ID associated with the DB instance
2724 */
2725 VpcId?: String;
2726 /**
2727 * Provides the date and time that the DB instance was created.
2728 */
2729 InstanceCreateTime?: TStamp;
2730 /**
2731 * The license model of an automated backup.
2732 */
2733 MasterUsername?: String;
2734 /**
2735 * The name of the database engine for this automated backup.
2736 */
2737 Engine?: String;
2738 /**
2739 * The version of the database engine for the automated backup.
2740 */
2741 EngineVersion?: String;
2742 /**
2743 * License model information for the automated backup.
2744 */
2745 LicenseModel?: String;
2746 /**
2747 * The IOPS (I/O operations per second) value for the automated backup.
2748 */
2749 Iops?: IntegerOptional;
2750 /**
2751 * The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
2752 */
2753 OptionGroupName?: String;
2754 /**
2755 * The ARN from the key store with which the automated backup is associated for TDE encryption.
2756 */
2757 TdeCredentialArn?: String;
2758 /**
2759 * Specifies whether the automated backup is encrypted.
2760 */
2761 Encrypted?: Boolean;
2762 /**
2763 * Specifies the storage type associated with the automated backup.
2764 */
2765 StorageType?: String;
2766 /**
2767 * The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
2768 */
2769 KmsKeyId?: String;
2770 /**
2771 * The time zone of the automated backup. 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.
2772 */
2773 Timezone?: String;
2774 /**
2775 * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
2776 */
2777 IAMDatabaseAuthenticationEnabled?: Boolean;
2778 }
2779 export type DBInstanceAutomatedBackupList = DBInstanceAutomatedBackup[];
2780 export interface DBInstanceAutomatedBackupMessage {
2781 /**
2782 * 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 .
2783 */
2784 Marker?: String;
2785 /**
2786 * A list of DBInstanceAutomatedBackup instances.
2787 */
2788 DBInstanceAutomatedBackups?: DBInstanceAutomatedBackupList;
2789 }
2790 export type DBInstanceList = DBInstance[];
2791 export interface DBInstanceMessage {
2792 /**
2793 * 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 .
2794 */
2795 Marker?: String;
2796 /**
2797 * A list of DBInstance instances.
2798 */
2799 DBInstances?: DBInstanceList;
2800 }
2801 export interface DBInstanceRole {
2802 /**
2803 * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
2804 */
2805 RoleArn?: String;
2806 /**
2807 * The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.
2808 */
2809 FeatureName?: String;
2810 /**
2811 * Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values: ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf. PENDING - the IAM role ARN is being associated with the DB instance. INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.
2812 */
2813 Status?: String;
2814 }
2815 export type DBInstanceRoles = DBInstanceRole[];
2816 export interface DBInstanceStatusInfo {
2817 /**
2818 * This value is currently "read replication."
2819 */
2820 StatusType?: String;
2821 /**
2822 * Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
2823 */
2824 Normal?: Boolean;
2825 /**
2826 * Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
2827 */
2828 Status?: String;
2829 /**
2830 * 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.
2831 */
2832 Message?: String;
2833 }
2834 export type DBInstanceStatusInfoList = DBInstanceStatusInfo[];
2835 export interface DBParameterGroup {
2836 /**
2837 * Provides the name of the DB parameter group.
2838 */
2839 DBParameterGroupName?: String;
2840 /**
2841 * Provides the name of the DB parameter group family that this DB parameter group is compatible with.
2842 */
2843 DBParameterGroupFamily?: String;
2844 /**
2845 * Provides the customer-specified description for this DB parameter group.
2846 */
2847 Description?: String;
2848 /**
2849 * The Amazon Resource Name (ARN) for the DB parameter group.
2850 */
2851 DBParameterGroupArn?: String;
2852 }
2853 export interface DBParameterGroupDetails {
2854 /**
2855 * A list of Parameter values.
2856 */
2857 Parameters?: ParametersList;
2858 /**
2859 * 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.
2860 */
2861 Marker?: String;
2862 }
2863 export type DBParameterGroupList = DBParameterGroup[];
2864 export interface DBParameterGroupNameMessage {
2865 /**
2866 * Provides the name of the DB parameter group.
2867 */
2868 DBParameterGroupName?: String;
2869 }
2870 export interface DBParameterGroupStatus {
2871 /**
2872 * The name of the DP parameter group.
2873 */
2874 DBParameterGroupName?: String;
2875 /**
2876 * The status of parameter updates.
2877 */
2878 ParameterApplyStatus?: String;
2879 }
2880 export type DBParameterGroupStatusList = DBParameterGroupStatus[];
2881 export interface DBParameterGroupsMessage {
2882 /**
2883 * 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.
2884 */
2885 Marker?: String;
2886 /**
2887 * A list of DBParameterGroup instances.
2888 */
2889 DBParameterGroups?: DBParameterGroupList;
2890 }
2891 export interface DBSecurityGroup {
2892 /**
2893 * Provides the AWS ID of the owner of a specific DB security group.
2894 */
2895 OwnerId?: String;
2896 /**
2897 * Specifies the name of the DB security group.
2898 */
2899 DBSecurityGroupName?: String;
2900 /**
2901 * Provides the description of the DB security group.
2902 */
2903 DBSecurityGroupDescription?: String;
2904 /**
2905 * Provides the VpcId of the DB security group.
2906 */
2907 VpcId?: String;
2908 /**
2909 * Contains a list of EC2SecurityGroup elements.
2910 */
2911 EC2SecurityGroups?: EC2SecurityGroupList;
2912 /**
2913 * Contains a list of IPRange elements.
2914 */
2915 IPRanges?: IPRangeList;
2916 /**
2917 * The Amazon Resource Name (ARN) for the DB security group.
2918 */
2919 DBSecurityGroupArn?: String;
2920 }
2921 export interface DBSecurityGroupMembership {
2922 /**
2923 * The name of the DB security group.
2924 */
2925 DBSecurityGroupName?: String;
2926 /**
2927 * The status of the DB security group.
2928 */
2929 Status?: String;
2930 }
2931 export type DBSecurityGroupMembershipList = DBSecurityGroupMembership[];
2932 export interface DBSecurityGroupMessage {
2933 /**
2934 * 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.
2935 */
2936 Marker?: String;
2937 /**
2938 * A list of DBSecurityGroup instances.
2939 */
2940 DBSecurityGroups?: DBSecurityGroups;
2941 }
2942 export type DBSecurityGroupNameList = String[];
2943 export type DBSecurityGroups = DBSecurityGroup[];
2944 export interface DBSnapshot {
2945 /**
2946 * Specifies the identifier for the DB snapshot.
2947 */
2948 DBSnapshotIdentifier?: String;
2949 /**
2950 * Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
2951 */
2952 DBInstanceIdentifier?: String;
2953 /**
2954 * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
2955 */
2956 SnapshotCreateTime?: TStamp;
2957 /**
2958 * Specifies the name of the database engine.
2959 */
2960 Engine?: String;
2961 /**
2962 * Specifies the allocated storage size in gibibytes (GiB).
2963 */
2964 AllocatedStorage?: Integer;
2965 /**
2966 * Specifies the status of this DB snapshot.
2967 */
2968 Status?: String;
2969 /**
2970 * Specifies the port that the database engine was listening on at the time of the snapshot.
2971 */
2972 Port?: Integer;
2973 /**
2974 * Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
2975 */
2976 AvailabilityZone?: String;
2977 /**
2978 * Provides the VPC ID associated with the DB snapshot.
2979 */
2980 VpcId?: String;
2981 /**
2982 * Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
2983 */
2984 InstanceCreateTime?: TStamp;
2985 /**
2986 * Provides the master username for the DB snapshot.
2987 */
2988 MasterUsername?: String;
2989 /**
2990 * Specifies the version of the database engine.
2991 */
2992 EngineVersion?: String;
2993 /**
2994 * License model information for the restored DB instance.
2995 */
2996 LicenseModel?: String;
2997 /**
2998 * Provides the type of the DB snapshot.
2999 */
3000 SnapshotType?: String;
3001 /**
3002 * Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
3003 */
3004 Iops?: IntegerOptional;
3005 /**
3006 * Provides the option group name for the DB snapshot.
3007 */
3008 OptionGroupName?: String;
3009 /**
3010 * The percentage of the estimated data that has been transferred.
3011 */
3012 PercentProgress?: Integer;
3013 /**
3014 * The AWS Region that the DB snapshot was created in or copied from.
3015 */
3016 SourceRegion?: String;
3017 /**
3018 * The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
3019 */
3020 SourceDBSnapshotIdentifier?: String;
3021 /**
3022 * Specifies the storage type associated with DB snapshot.
3023 */
3024 StorageType?: String;
3025 /**
3026 * The ARN from the key store with which to associate the instance for TDE encryption.
3027 */
3028 TdeCredentialArn?: String;
3029 /**
3030 * Specifies whether the DB snapshot is encrypted.
3031 */
3032 Encrypted?: Boolean;
3033 /**
3034 * If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
3035 */
3036 KmsKeyId?: String;
3037 /**
3038 * The Amazon Resource Name (ARN) for the DB snapshot.
3039 */
3040 DBSnapshotArn?: String;
3041 /**
3042 * 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.
3043 */
3044 Timezone?: String;
3045 /**
3046 * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
3047 */
3048 IAMDatabaseAuthenticationEnabled?: Boolean;
3049 /**
3050 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
3051 */
3052 ProcessorFeatures?: ProcessorFeatureList;
3053 /**
3054 * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
3055 */
3056 DbiResourceId?: String;
3057 }
3058 export interface DBSnapshotAttribute {
3059 /**
3060 * 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.
3061 */
3062 AttributeName?: String;
3063 /**
3064 * 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.
3065 */
3066 AttributeValues?: AttributeValueList;
3067 }
3068 export type DBSnapshotAttributeList = DBSnapshotAttribute[];
3069 export interface DBSnapshotAttributesResult {
3070 /**
3071 * The identifier of the manual DB snapshot that the attributes apply to.
3072 */
3073 DBSnapshotIdentifier?: String;
3074 /**
3075 * The list of attributes and values for the manual DB snapshot.
3076 */
3077 DBSnapshotAttributes?: DBSnapshotAttributeList;
3078 }
3079 export type DBSnapshotList = DBSnapshot[];
3080 export interface DBSnapshotMessage {
3081 /**
3082 * 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.
3083 */
3084 Marker?: String;
3085 /**
3086 * A list of DBSnapshot instances.
3087 */
3088 DBSnapshots?: DBSnapshotList;
3089 }
3090 export interface DBSubnetGroup {
3091 /**
3092 * The name of the DB subnet group.
3093 */
3094 DBSubnetGroupName?: String;
3095 /**
3096 * Provides the description of the DB subnet group.
3097 */
3098 DBSubnetGroupDescription?: String;
3099 /**
3100 * Provides the VpcId of the DB subnet group.
3101 */
3102 VpcId?: String;
3103 /**
3104 * Provides the status of the DB subnet group.
3105 */
3106 SubnetGroupStatus?: String;
3107 /**
3108 * Contains a list of Subnet elements.
3109 */
3110 Subnets?: SubnetList;
3111 /**
3112 * The Amazon Resource Name (ARN) for the DB subnet group.
3113 */
3114 DBSubnetGroupArn?: String;
3115 }
3116 export interface DBSubnetGroupMessage {
3117 /**
3118 * 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.
3119 */
3120 Marker?: String;
3121 /**
3122 * A list of DBSubnetGroup instances.
3123 */
3124 DBSubnetGroups?: DBSubnetGroups;
3125 }
3126 export type DBSubnetGroups = DBSubnetGroup[];
3127 export interface DeleteDBClusterEndpointMessage {
3128 /**
3129 * The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
3130 */
3131 DBClusterEndpointIdentifier: String;
3132 }
3133 export interface DeleteDBClusterMessage {
3134 /**
3135 * The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: Must match an existing DBClusterIdentifier.
3136 */
3137 DBClusterIdentifier: String;
3138 /**
3139 * 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
3140 */
3141 SkipFinalSnapshot?: Boolean;
3142 /**
3143 * 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 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
3144 */
3145 FinalDBSnapshotIdentifier?: String;
3146 }
3147 export interface DeleteDBClusterParameterGroupMessage {
3148 /**
3149 * The name of the DB cluster parameter group. Constraints: Must be the name of an existing DB cluster parameter group. You can't delete a default DB cluster parameter group. Can't be associated with any DB clusters.
3150 */
3151 DBClusterParameterGroupName: String;
3152 }
3153 export interface DeleteDBClusterResult {
3154 DBCluster?: DBCluster;
3155 }
3156 export interface DeleteDBClusterSnapshotMessage {
3157 /**
3158 * The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state.
3159 */
3160 DBClusterSnapshotIdentifier: String;
3161 }
3162 export interface DeleteDBClusterSnapshotResult {
3163 DBClusterSnapshot?: DBClusterSnapshot;
3164 }
3165 export interface DeleteDBInstanceAutomatedBackupMessage {
3166 /**
3167 * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
3168 */
3169 DbiResourceId: String;
3170 }
3171 export interface DeleteDBInstanceAutomatedBackupResult {
3172 DBInstanceAutomatedBackup?: DBInstanceAutomatedBackup;
3173 }
3174 export interface DeleteDBInstanceMessage {
3175 /**
3176 * The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. Constraints: Must match the name of an existing DB instance.
3177 */
3178 DBInstanceIdentifier: String;
3179 /**
3180 * A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted. 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. Specify true when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false. Default: false
3181 */
3182 SkipFinalSnapshot?: Boolean;
3183 /**
3184 * The DBSnapshotIdentifier of the new DB 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 letters or numbers. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Can't be specified when deleting a Read Replica.
3185 */
3186 FinalDBSnapshotIdentifier?: String;
3187 /**
3188 * A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. This parameter defaults to true.
3189 */
3190 DeleteAutomatedBackups?: BooleanOptional;
3191 }
3192 export interface DeleteDBInstanceResult {
3193 DBInstance?: DBInstance;
3194 }
3195 export interface DeleteDBParameterGroupMessage {
3196 /**
3197 * The name of the DB parameter group. Constraints: Must be the name of an existing DB parameter group You can't delete a default DB parameter group Can't be associated with any DB instances
3198 */
3199 DBParameterGroupName: String;
3200 }
3201 export interface DeleteDBSecurityGroupMessage {
3202 /**
3203 * The name of the DB security group to delete. You can't delete the default DB security group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Must not be "Default"
3204 */
3205 DBSecurityGroupName: String;
3206 }
3207 export interface DeleteDBSnapshotMessage {
3208 /**
3209 * The DB snapshot identifier. Constraints: Must be the name of an existing DB snapshot in the available state.
3210 */
3211 DBSnapshotIdentifier: String;
3212 }
3213 export interface DeleteDBSnapshotResult {
3214 DBSnapshot?: DBSnapshot;
3215 }
3216 export interface DeleteDBSubnetGroupMessage {
3217 /**
3218 * The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
3219 */
3220 DBSubnetGroupName: String;
3221 }
3222 export interface DeleteEventSubscriptionMessage {
3223 /**
3224 * The name of the RDS event notification subscription you want to delete.
3225 */
3226 SubscriptionName: String;
3227 }
3228 export interface DeleteEventSubscriptionResult {
3229 EventSubscription?: EventSubscription;
3230 }
3231 export interface DeleteGlobalClusterMessage {
3232 /**
3233 * The cluster identifier of the global database cluster being deleted.
3234 */
3235 GlobalClusterIdentifier: String;
3236 }
3237 export interface DeleteGlobalClusterResult {
3238 GlobalCluster?: GlobalCluster;
3239 }
3240 export interface DeleteOptionGroupMessage {
3241 /**
3242 * The name of the option group to be deleted. You can't delete default option groups.
3243 */
3244 OptionGroupName: String;
3245 }
3246 export interface DescribeAccountAttributesMessage {
3247 }
3248 export interface DescribeCertificatesMessage {
3249 /**
3250 * 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 match an existing CertificateIdentifier.
3251 */
3252 CertificateIdentifier?: String;
3253 /**
3254 * This parameter is not currently supported.
3255 */
3256 Filters?: FilterList;
3257 /**
3258 * 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.
3259 */
3260 MaxRecords?: IntegerOptional;
3261 /**
3262 * 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.
3263 */
3264 Marker?: String;
3265 }
3266 export interface DescribeDBClusterBacktracksMessage {
3267 /**
3268 * The DB cluster identifier of the DB cluster to be described. 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. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
3269 */
3270 DBClusterIdentifier: String;
3271 /**
3272 * If specified, this value is the backtrack identifier of the backtrack to be described. Constraints: Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace. Example: 123e4567-e89b-12d3-a456-426655440000
3273 */
3274 BacktrackIdentifier?: String;
3275 /**
3276 * A filter that specifies one or more DB clusters to describe. Supported filters include the following: db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers. db-cluster-backtrack-status - Accepts any of the following backtrack status values: applying completed failed pending The results list includes information about only the backtracks identified by these values. For more information about backtrack status values, see DBClusterBacktrack.
3277 */
3278 Filters?: FilterList;
3279 /**
3280 * 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.
3281 */
3282 MaxRecords?: IntegerOptional;
3283 /**
3284 * An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
3285 */
3286 Marker?: String;
3287 }
3288 export interface DescribeDBClusterEndpointsMessage {
3289 /**
3290 * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
3291 */
3292 DBClusterIdentifier?: String;
3293 /**
3294 * The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
3295 */
3296 DBClusterEndpointIdentifier?: String;
3297 /**
3298 * A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.
3299 */
3300 Filters?: FilterList;
3301 /**
3302 * 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.
3303 */
3304 MaxRecords?: IntegerOptional;
3305 /**
3306 * An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
3307 */
3308 Marker?: String;
3309 }
3310 export interface DescribeDBClusterParameterGroupsMessage {
3311 /**
3312 * The name of a specific DB cluster parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
3313 */
3314 DBClusterParameterGroupName?: String;
3315 /**
3316 * This parameter is not currently supported.
3317 */
3318 Filters?: FilterList;
3319 /**
3320 * 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.
3321 */
3322 MaxRecords?: IntegerOptional;
3323 /**
3324 * 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.
3325 */
3326 Marker?: String;
3327 }
3328 export interface DescribeDBClusterParametersMessage {
3329 /**
3330 * The name of a specific DB cluster parameter group to return parameter details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
3331 */
3332 DBClusterParameterGroupName: String;
3333 /**
3334 * A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
3335 */
3336 Source?: String;
3337 /**
3338 * This parameter is not currently supported.
3339 */
3340 Filters?: FilterList;
3341 /**
3342 * 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.
3343 */
3344 MaxRecords?: IntegerOptional;
3345 /**
3346 * 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.
3347 */
3348 Marker?: String;
3349 }
3350 export interface DescribeDBClusterSnapshotAttributesMessage {
3351 /**
3352 * The identifier for the DB cluster snapshot to describe the attributes for.
3353 */
3354 DBClusterSnapshotIdentifier: String;
3355 }
3356 export interface DescribeDBClusterSnapshotAttributesResult {
3357 DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
3358 }
3359 export interface DescribeDBClusterSnapshotsMessage {
3360 /**
3361 * The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster.
3362 */
3363 DBClusterIdentifier?: String;
3364 /**
3365 * A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
3366 */
3367 DBClusterSnapshotIdentifier?: String;
3368 /**
3369 * 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.
3370 */
3371 SnapshotType?: String;
3372 /**
3373 * This parameter is not currently supported.
3374 */
3375 Filters?: FilterList;
3376 /**
3377 * 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.
3378 */
3379 MaxRecords?: IntegerOptional;
3380 /**
3381 * 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.
3382 */
3383 Marker?: String;
3384 /**
3385 * True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise 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.
3386 */
3387 IncludeShared?: Boolean;
3388 /**
3389 * True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise 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.
3390 */
3391 IncludePublic?: Boolean;
3392 }
3393 export interface DescribeDBClustersMessage {
3394 /**
3395 * 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: If supplied, must match an existing DBClusterIdentifier.
3396 */
3397 DBClusterIdentifier?: String;
3398 /**
3399 * A filter that specifies one or more DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
3400 */
3401 Filters?: FilterList;
3402 /**
3403 * 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.
3404 */
3405 MaxRecords?: IntegerOptional;
3406 /**
3407 * 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.
3408 */
3409 Marker?: String;
3410 }
3411 export interface DescribeDBEngineVersionsMessage {
3412 /**
3413 * The database engine to return.
3414 */
3415 Engine?: String;
3416 /**
3417 * The database engine version to return. Example: 5.1.49
3418 */
3419 EngineVersion?: String;
3420 /**
3421 * The name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DBParameterGroupFamily.
3422 */
3423 DBParameterGroupFamily?: String;
3424 /**
3425 * This parameter is not currently supported.
3426 */
3427 Filters?: FilterList;
3428 /**
3429 * 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.
3430 */
3431 MaxRecords?: IntegerOptional;
3432 /**
3433 * 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.
3434 */
3435 Marker?: String;
3436 /**
3437 * Indicates that only the default version of the specified engine or engine and major version combination is returned.
3438 */
3439 DefaultOnly?: Boolean;
3440 /**
3441 * 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.
3442 */
3443 ListSupportedCharacterSets?: BooleanOptional;
3444 /**
3445 * 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.
3446 */
3447 ListSupportedTimezones?: BooleanOptional;
3448 }
3449 export interface DescribeDBInstanceAutomatedBackupsMessage {
3450 /**
3451 * The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
3452 */
3453 DbiResourceId?: String;
3454 /**
3455 * (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.
3456 */
3457 DBInstanceIdentifier?: String;
3458 /**
3459 * A filter that specifies which resources to return based on status. Supported filters are the following: status active - automated backups for current instances retained - automated backups for deleted instances creating - automated backups that are waiting for the first automated snapshot to be available db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs. dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance resources identified by these ARNs. Returns all resources by default. The status for each resource is specified in the response.
3460 */
3461 Filters?: FilterList;
3462 /**
3463 * 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.
3464 */
3465 MaxRecords?: IntegerOptional;
3466 /**
3467 * The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
3468 */
3469 Marker?: String;
3470 }
3471 export interface DescribeDBInstancesMessage {
3472 /**
3473 * 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: If supplied, must match the identifier of an existing DBInstance.
3474 */
3475 DBInstanceIdentifier?: String;
3476 /**
3477 * A filter that specifies one or more DB instances to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.
3478 */
3479 Filters?: FilterList;
3480 /**
3481 * 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.
3482 */
3483 MaxRecords?: IntegerOptional;
3484 /**
3485 * 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.
3486 */
3487 Marker?: String;
3488 }
3489 export interface DescribeDBLogFilesDetails {
3490 /**
3491 * The name of the log file for the specified DB instance.
3492 */
3493 LogFileName?: String;
3494 /**
3495 * A POSIX timestamp when the last log entry was written.
3496 */
3497 LastWritten?: Long;
3498 /**
3499 * The size, in bytes, of the log file for the specified DB instance.
3500 */
3501 Size?: Long;
3502 }
3503 export type DescribeDBLogFilesList = DescribeDBLogFilesDetails[];
3504 export interface DescribeDBLogFilesMessage {
3505 /**
3506 * The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: Must match the identifier of an existing DBInstance.
3507 */
3508 DBInstanceIdentifier: String;
3509 /**
3510 * Filters the available log files for log file names that contain the specified string.
3511 */
3512 FilenameContains?: String;
3513 /**
3514 * Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
3515 */
3516 FileLastWritten?: Long;
3517 /**
3518 * Filters the available log files for files larger than the specified size.
3519 */
3520 FileSize?: Long;
3521 /**
3522 * This parameter is not currently supported.
3523 */
3524 Filters?: FilterList;
3525 /**
3526 * 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.
3527 */
3528 MaxRecords?: IntegerOptional;
3529 /**
3530 * The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
3531 */
3532 Marker?: String;
3533 }
3534 export interface DescribeDBLogFilesResponse {
3535 /**
3536 * The DB log files returned.
3537 */
3538 DescribeDBLogFiles?: DescribeDBLogFilesList;
3539 /**
3540 * A pagination token that can be used in a subsequent DescribeDBLogFiles request.
3541 */
3542 Marker?: String;
3543 }
3544 export interface DescribeDBParameterGroupsMessage {
3545 /**
3546 * The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
3547 */
3548 DBParameterGroupName?: String;
3549 /**
3550 * This parameter is not currently supported.
3551 */
3552 Filters?: FilterList;
3553 /**
3554 * 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.
3555 */
3556 MaxRecords?: IntegerOptional;
3557 /**
3558 * 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.
3559 */
3560 Marker?: String;
3561 }
3562 export interface DescribeDBParametersMessage {
3563 /**
3564 * The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBParameterGroup.
3565 */
3566 DBParameterGroupName: String;
3567 /**
3568 * The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default
3569 */
3570 Source?: String;
3571 /**
3572 * This parameter is not currently supported.
3573 */
3574 Filters?: FilterList;
3575 /**
3576 * 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.
3577 */
3578 MaxRecords?: IntegerOptional;
3579 /**
3580 * 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.
3581 */
3582 Marker?: String;
3583 }
3584 export interface DescribeDBSecurityGroupsMessage {
3585 /**
3586 * The name of the DB security group to return details for.
3587 */
3588 DBSecurityGroupName?: String;
3589 /**
3590 * This parameter is not currently supported.
3591 */
3592 Filters?: FilterList;
3593 /**
3594 * 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.
3595 */
3596 MaxRecords?: IntegerOptional;
3597 /**
3598 * 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.
3599 */
3600 Marker?: String;
3601 }
3602 export interface DescribeDBSnapshotAttributesMessage {
3603 /**
3604 * The identifier for the DB snapshot to describe the attributes for.
3605 */
3606 DBSnapshotIdentifier: String;
3607 }
3608 export interface DescribeDBSnapshotAttributesResult {
3609 DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
3610 }
3611 export interface DescribeDBSnapshotsMessage {
3612 /**
3613 * The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance.
3614 */
3615 DBInstanceIdentifier?: String;
3616 /**
3617 * A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
3618 */
3619 DBSnapshotIdentifier?: String;
3620 /**
3621 * 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. awsbackup - Return the DB snapshots managed by the AWS Backup service. For information about AWS Backup, see the AWS Backup Developer Guide. The awsbackup type does not apply to Aurora. 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.
3622 */
3623 SnapshotType?: String;
3624 /**
3625 * This parameter is not currently supported.
3626 */
3627 Filters?: FilterList;
3628 /**
3629 * 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.
3630 */
3631 MaxRecords?: IntegerOptional;
3632 /**
3633 * 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.
3634 */
3635 Marker?: String;
3636 /**
3637 * True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise 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.
3638 */
3639 IncludeShared?: Boolean;
3640 /**
3641 * True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
3642 */
3643 IncludePublic?: Boolean;
3644 /**
3645 * A specific DB resource ID to describe.
3646 */
3647 DbiResourceId?: String;
3648 }
3649 export interface DescribeDBSubnetGroupsMessage {
3650 /**
3651 * The name of the DB subnet group to return details for.
3652 */
3653 DBSubnetGroupName?: String;
3654 /**
3655 * This parameter is not currently supported.
3656 */
3657 Filters?: FilterList;
3658 /**
3659 * 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.
3660 */
3661 MaxRecords?: IntegerOptional;
3662 /**
3663 * 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.
3664 */
3665 Marker?: String;
3666 }
3667 export interface DescribeEngineDefaultClusterParametersMessage {
3668 /**
3669 * The name of the DB cluster parameter group family to return engine parameter information for.
3670 */
3671 DBParameterGroupFamily: String;
3672 /**
3673 * This parameter is not currently supported.
3674 */
3675 Filters?: FilterList;
3676 /**
3677 * 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.
3678 */
3679 MaxRecords?: IntegerOptional;
3680 /**
3681 * 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.
3682 */
3683 Marker?: String;
3684 }
3685 export interface DescribeEngineDefaultClusterParametersResult {
3686 EngineDefaults?: EngineDefaults;
3687 }
3688 export interface DescribeEngineDefaultParametersMessage {
3689 /**
3690 * The name of the DB parameter group family.
3691 */
3692 DBParameterGroupFamily: String;
3693 /**
3694 * This parameter is not currently supported.
3695 */
3696 Filters?: FilterList;
3697 /**
3698 * 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.
3699 */
3700 MaxRecords?: IntegerOptional;
3701 /**
3702 * 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.
3703 */
3704 Marker?: String;
3705 }
3706 export interface DescribeEngineDefaultParametersResult {
3707 EngineDefaults?: EngineDefaults;
3708 }
3709 export interface DescribeEventCategoriesMessage {
3710 /**
3711 * The type of source that is generating the events. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
3712 */
3713 SourceType?: String;
3714 /**
3715 * This parameter is not currently supported.
3716 */
3717 Filters?: FilterList;
3718 }
3719 export interface DescribeEventSubscriptionsMessage {
3720 /**
3721 * The name of the RDS event notification subscription you want to describe.
3722 */
3723 SubscriptionName?: String;
3724 /**
3725 * This parameter is not currently supported.
3726 */
3727 Filters?: FilterList;
3728 /**
3729 * 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.
3730 */
3731 MaxRecords?: IntegerOptional;
3732 /**
3733 * 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 .
3734 */
3735 Marker?: String;
3736 }
3737 export interface DescribeEventsMessage {
3738 /**
3739 * The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is 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. Can't end with a hyphen or contain two consecutive hyphens.
3740 */
3741 SourceIdentifier?: String;
3742 /**
3743 * The event source to retrieve events for. If no value is specified, all events are returned.
3744 */
3745 SourceType?: SourceType;
3746 /**
3747 * 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
3748 */
3749 StartTime?: TStamp;
3750 /**
3751 * 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
3752 */
3753 EndTime?: TStamp;
3754 /**
3755 * The number of minutes to retrieve events for. Default: 60
3756 */
3757 Duration?: IntegerOptional;
3758 /**
3759 * A list of event categories that trigger notifications for a event notification subscription.
3760 */
3761 EventCategories?: EventCategoriesList;
3762 /**
3763 * This parameter is not currently supported.
3764 */
3765 Filters?: FilterList;
3766 /**
3767 * 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.
3768 */
3769 MaxRecords?: IntegerOptional;
3770 /**
3771 * 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.
3772 */
3773 Marker?: String;
3774 }
3775 export interface DescribeGlobalClustersMessage {
3776 /**
3777 * 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: If supplied, must match an existing DBClusterIdentifier.
3778 */
3779 GlobalClusterIdentifier?: String;
3780 /**
3781 * A filter that specifies one or more global DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
3782 */
3783 Filters?: FilterList;
3784 /**
3785 * 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.
3786 */
3787 MaxRecords?: IntegerOptional;
3788 /**
3789 * An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
3790 */
3791 Marker?: String;
3792 }
3793 export interface DescribeOptionGroupOptionsMessage {
3794 /**
3795 * A required parameter. Options available for the given engine name are described.
3796 */
3797 EngineName: String;
3798 /**
3799 * If specified, filters the results to include only options for the specified major engine version.
3800 */
3801 MajorEngineVersion?: String;
3802 /**
3803 * This parameter is not currently supported.
3804 */
3805 Filters?: FilterList;
3806 /**
3807 * 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.
3808 */
3809 MaxRecords?: IntegerOptional;
3810 /**
3811 * 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.
3812 */
3813 Marker?: String;
3814 }
3815 export interface DescribeOptionGroupsMessage {
3816 /**
3817 * The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
3818 */
3819 OptionGroupName?: String;
3820 /**
3821 * This parameter is not currently supported.
3822 */
3823 Filters?: FilterList;
3824 /**
3825 * 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.
3826 */
3827 Marker?: String;
3828 /**
3829 * 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.
3830 */
3831 MaxRecords?: IntegerOptional;
3832 /**
3833 * Filters the list of option groups to only include groups associated with a specific database engine.
3834 */
3835 EngineName?: String;
3836 /**
3837 * 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.
3838 */
3839 MajorEngineVersion?: String;
3840 }
3841 export interface DescribeOrderableDBInstanceOptionsMessage {
3842 /**
3843 * The name of the engine to retrieve DB instance options for.
3844 */
3845 Engine: String;
3846 /**
3847 * The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
3848 */
3849 EngineVersion?: String;
3850 /**
3851 * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
3852 */
3853 DBInstanceClass?: String;
3854 /**
3855 * The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
3856 */
3857 LicenseModel?: String;
3858 /**
3859 * The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
3860 */
3861 Vpc?: BooleanOptional;
3862 /**
3863 * This parameter is not currently supported.
3864 */
3865 Filters?: FilterList;
3866 /**
3867 * 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.
3868 */
3869 MaxRecords?: IntegerOptional;
3870 /**
3871 * 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 .
3872 */
3873 Marker?: String;
3874 }
3875 export interface DescribePendingMaintenanceActionsMessage {
3876 /**
3877 * The ARN of a resource to return pending maintenance actions for.
3878 */
3879 ResourceIdentifier?: String;
3880 /**
3881 * A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.
3882 */
3883 Filters?: FilterList;
3884 /**
3885 * 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.
3886 */
3887 Marker?: String;
3888 /**
3889 * 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.
3890 */
3891 MaxRecords?: IntegerOptional;
3892 }
3893 export interface DescribeReservedDBInstancesMessage {
3894 /**
3895 * The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
3896 */
3897 ReservedDBInstanceId?: String;
3898 /**
3899 * The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
3900 */
3901 ReservedDBInstancesOfferingId?: String;
3902 /**
3903 * The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
3904 */
3905 DBInstanceClass?: String;
3906 /**
3907 * 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
3908 */
3909 Duration?: String;
3910 /**
3911 * The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
3912 */
3913 ProductDescription?: String;
3914 /**
3915 * 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"
3916 */
3917 OfferingType?: String;
3918 /**
3919 * The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.
3920 */
3921 MultiAZ?: BooleanOptional;
3922 /**
3923 * This parameter is not currently supported.
3924 */
3925 Filters?: FilterList;
3926 /**
3927 * 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.
3928 */
3929 MaxRecords?: IntegerOptional;
3930 /**
3931 * 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.
3932 */
3933 Marker?: String;
3934 }
3935 export interface DescribeReservedDBInstancesOfferingsMessage {
3936 /**
3937 * 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
3938 */
3939 ReservedDBInstancesOfferingId?: String;
3940 /**
3941 * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
3942 */
3943 DBInstanceClass?: String;
3944 /**
3945 * Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
3946 */
3947 Duration?: String;
3948 /**
3949 * Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description. The results show offerings that partially match the filter value.
3950 */
3951 ProductDescription?: String;
3952 /**
3953 * 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"
3954 */
3955 OfferingType?: String;
3956 /**
3957 * The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.
3958 */
3959 MultiAZ?: BooleanOptional;
3960 /**
3961 * This parameter is not currently supported.
3962 */
3963 Filters?: FilterList;
3964 /**
3965 * 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.
3966 */
3967 MaxRecords?: IntegerOptional;
3968 /**
3969 * 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.
3970 */
3971 Marker?: String;
3972 }
3973 export interface DescribeSourceRegionsMessage {
3974 /**
3975 * The source AWS Region name. For example, us-east-1. Constraints: Must specify a valid AWS Region name.
3976 */
3977 RegionName?: String;
3978 /**
3979 * 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.
3980 */
3981 MaxRecords?: IntegerOptional;
3982 /**
3983 * 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.
3984 */
3985 Marker?: String;
3986 /**
3987 * This parameter is not currently supported.
3988 */
3989 Filters?: FilterList;
3990 }
3991 export interface DescribeValidDBInstanceModificationsMessage {
3992 /**
3993 * The customer identifier or the ARN of your DB instance.
3994 */
3995 DBInstanceIdentifier: String;
3996 }
3997 export interface DescribeValidDBInstanceModificationsResult {
3998 ValidDBInstanceModificationsMessage?: ValidDBInstanceModificationsMessage;
3999 }
4000 export interface DomainMembership {
4001 /**
4002 * The identifier of the Active Directory Domain.
4003 */
4004 Domain?: String;
4005 /**
4006 * The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
4007 */
4008 Status?: String;
4009 /**
4010 * The fully qualified domain name of the Active Directory Domain.
4011 */
4012 FQDN?: String;
4013 /**
4014 * The name of the IAM role to be used when making API calls to the Directory Service.
4015 */
4016 IAMRoleName?: String;
4017 }
4018 export type DomainMembershipList = DomainMembership[];
4019 export type Double = number;
4020 export type DoubleOptional = number;
4021 export interface DoubleRange {
4022 /**
4023 * The minimum value in the range.
4024 */
4025 From?: Double;
4026 /**
4027 * The maximum value in the range.
4028 */
4029 To?: Double;
4030 }
4031 export type DoubleRangeList = DoubleRange[];
4032 export interface DownloadDBLogFilePortionDetails {
4033 /**
4034 * Entries from the specified log file.
4035 */
4036 LogFileData?: String;
4037 /**
4038 * A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.
4039 */
4040 Marker?: String;
4041 /**
4042 * Boolean value that if true, indicates there is more data to be downloaded.
4043 */
4044 AdditionalDataPending?: Boolean;
4045 }
4046 export interface DownloadDBLogFilePortionMessage {
4047 /**
4048 * The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: Must match the identifier of an existing DBInstance.
4049 */
4050 DBInstanceIdentifier: String;
4051 /**
4052 * The name of the log file to be downloaded.
4053 */
4054 LogFileName: String;
4055 /**
4056 * 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.
4057 */
4058 Marker?: String;
4059 /**
4060 * The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size. 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.
4061 */
4062 NumberOfLines?: Integer;
4063 }
4064 export interface EC2SecurityGroup {
4065 /**
4066 * Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
4067 */
4068 Status?: String;
4069 /**
4070 * Specifies the name of the EC2 security group.
4071 */
4072 EC2SecurityGroupName?: String;
4073 /**
4074 * Specifies the id of the EC2 security group.
4075 */
4076 EC2SecurityGroupId?: String;
4077 /**
4078 * Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
4079 */
4080 EC2SecurityGroupOwnerId?: String;
4081 }
4082 export type EC2SecurityGroupList = EC2SecurityGroup[];
4083 export interface Endpoint {
4084 /**
4085 * Specifies the DNS address of the DB instance.
4086 */
4087 Address?: String;
4088 /**
4089 * Specifies the port that the database engine is listening on.
4090 */
4091 Port?: Integer;
4092 /**
4093 * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
4094 */
4095 HostedZoneId?: String;
4096 }
4097 export interface EngineDefaults {
4098 /**
4099 * Specifies the name of the DB parameter group family that the engine default parameters apply to.
4100 */
4101 DBParameterGroupFamily?: String;
4102 /**
4103 * 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 .
4104 */
4105 Marker?: String;
4106 /**
4107 * Contains a list of engine default parameters.
4108 */
4109 Parameters?: ParametersList;
4110 }
4111 export type EngineModeList = String[];
4112 export interface Event {
4113 /**
4114 * Provides the identifier for the source of the event.
4115 */
4116 SourceIdentifier?: String;
4117 /**
4118 * Specifies the source type for this event.
4119 */
4120 SourceType?: SourceType;
4121 /**
4122 * Provides the text of this event.
4123 */
4124 Message?: String;
4125 /**
4126 * Specifies the category for the event.
4127 */
4128 EventCategories?: EventCategoriesList;
4129 /**
4130 * Specifies the date and time of the event.
4131 */
4132 Date?: TStamp;
4133 /**
4134 * The Amazon Resource Name (ARN) for the event.
4135 */
4136 SourceArn?: String;
4137 }
4138 export type EventCategoriesList = String[];
4139 export interface EventCategoriesMap {
4140 /**
4141 * The source type that the returned categories belong to
4142 */
4143 SourceType?: String;
4144 /**
4145 * The event categories for the specified source type
4146 */
4147 EventCategories?: EventCategoriesList;
4148 }
4149 export type EventCategoriesMapList = EventCategoriesMap[];
4150 export interface EventCategoriesMessage {
4151 /**
4152 * A list of EventCategoriesMap data types.
4153 */
4154 EventCategoriesMapList?: EventCategoriesMapList;
4155 }
4156 export type EventList = Event[];
4157 export interface EventSubscription {
4158 /**
4159 * The AWS customer account associated with the RDS event notification subscription.
4160 */
4161 CustomerAwsId?: String;
4162 /**
4163 * The RDS event notification subscription Id.
4164 */
4165 CustSubscriptionId?: String;
4166 /**
4167 * The topic ARN of the RDS event notification subscription.
4168 */
4169 SnsTopicArn?: String;
4170 /**
4171 * 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.
4172 */
4173 Status?: String;
4174 /**
4175 * The time the RDS event notification subscription was created.
4176 */
4177 SubscriptionCreationTime?: String;
4178 /**
4179 * The source type for the RDS event notification subscription.
4180 */
4181 SourceType?: String;
4182 /**
4183 * A list of source IDs for the RDS event notification subscription.
4184 */
4185 SourceIdsList?: SourceIdsList;
4186 /**
4187 * A list of event categories for the RDS event notification subscription.
4188 */
4189 EventCategoriesList?: EventCategoriesList;
4190 /**
4191 * A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
4192 */
4193 Enabled?: Boolean;
4194 /**
4195 * The Amazon Resource Name (ARN) for the event subscription.
4196 */
4197 EventSubscriptionArn?: String;
4198 }
4199 export type EventSubscriptionsList = EventSubscription[];
4200 export interface EventSubscriptionsMessage {
4201 /**
4202 * 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.
4203 */
4204 Marker?: String;
4205 /**
4206 * A list of EventSubscriptions data types.
4207 */
4208 EventSubscriptionsList?: EventSubscriptionsList;
4209 }
4210 export interface EventsMessage {
4211 /**
4212 * 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 .
4213 */
4214 Marker?: String;
4215 /**
4216 * A list of Event instances.
4217 */
4218 Events?: EventList;
4219 }
4220 export interface FailoverDBClusterMessage {
4221 /**
4222 * A DB cluster identifier to force a failover for. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster.
4223 */
4224 DBClusterIdentifier: String;
4225 /**
4226 * 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.
4227 */
4228 TargetDBInstanceIdentifier?: String;
4229 }
4230 export interface FailoverDBClusterResult {
4231 DBCluster?: DBCluster;
4232 }
4233 export type FeatureNameList = String[];
4234 export interface Filter {
4235 /**
4236 * The name of the filter. Filter names are case-sensitive.
4237 */
4238 Name: String;
4239 /**
4240 * One or more filter values. Filter values are case-sensitive.
4241 */
4242 Values: FilterValueList;
4243 }
4244 export type FilterList = Filter[];
4245 export type FilterValueList = String[];
4246 export interface GlobalCluster {
4247 /**
4248 * Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
4249 */
4250 GlobalClusterIdentifier?: String;
4251 /**
4252 * The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
4253 */
4254 GlobalClusterResourceId?: String;
4255 /**
4256 * The Amazon Resource Name (ARN) for the global database cluster.
4257 */
4258 GlobalClusterArn?: String;
4259 /**
4260 * Specifies the current state of this global database cluster.
4261 */
4262 Status?: String;
4263 /**
4264 * The Aurora database engine used by the global database cluster.
4265 */
4266 Engine?: String;
4267 /**
4268 * Indicates the database engine version.
4269 */
4270 EngineVersion?: String;
4271 /**
4272 * The default database name within the new global database cluster.
4273 */
4274 DatabaseName?: String;
4275 /**
4276 * The storage encryption setting for the global database cluster.
4277 */
4278 StorageEncrypted?: BooleanOptional;
4279 /**
4280 * The deletion protection setting for the new global database cluster.
4281 */
4282 DeletionProtection?: BooleanOptional;
4283 /**
4284 * The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
4285 */
4286 GlobalClusterMembers?: GlobalClusterMemberList;
4287 }
4288 export type GlobalClusterList = GlobalCluster[];
4289 export interface GlobalClusterMember {
4290 /**
4291 * The Amazon Resource Name (ARN) for each Aurora cluster.
4292 */
4293 DBClusterArn?: String;
4294 /**
4295 * The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
4296 */
4297 Readers?: ReadersArnList;
4298 /**
4299 * Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
4300 */
4301 IsWriter?: Boolean;
4302 }
4303 export type GlobalClusterMemberList = GlobalClusterMember[];
4304 export interface GlobalClustersMessage {
4305 /**
4306 * An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
4307 */
4308 Marker?: String;
4309 /**
4310 * The list of global clusters returned by this request.
4311 */
4312 GlobalClusters?: GlobalClusterList;
4313 }
4314 export interface IPRange {
4315 /**
4316 * Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
4317 */
4318 Status?: String;
4319 /**
4320 * Specifies the IP range.
4321 */
4322 CIDRIP?: String;
4323 }
4324 export type IPRangeList = IPRange[];
4325 export type Integer = number;
4326 export type IntegerOptional = number;
4327 export type KeyList = String[];
4328 export interface ListTagsForResourceMessage {
4329 /**
4330 * 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 ARN for Amazon RDS in the Amazon RDS User Guide.
4331 */
4332 ResourceName: String;
4333 /**
4334 * This parameter is not currently supported.
4335 */
4336 Filters?: FilterList;
4337 }
4338 export type LogTypeList = String[];
4339 export type Long = number;
4340 export type LongOptional = number;
4341 export interface MinimumEngineVersionPerAllowedValue {
4342 /**
4343 * The allowed value for an option setting.
4344 */
4345 AllowedValue?: String;
4346 /**
4347 * The minimum DB engine version required for the allowed value.
4348 */
4349 MinimumEngineVersion?: String;
4350 }
4351 export type MinimumEngineVersionPerAllowedValueList = MinimumEngineVersionPerAllowedValue[];
4352 export interface ModifyCurrentDBClusterCapacityMessage {
4353 /**
4354 * The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DB cluster.
4355 */
4356 DBClusterIdentifier: String;
4357 /**
4358 * The DB cluster capacity. Constraints: Value must be 2, 4, 8, 16, 32, 64, 128, or 256.
4359 */
4360 Capacity?: IntegerOptional;
4361 /**
4362 * The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Value must be from 10 through 600.
4363 */
4364 SecondsBeforeTimeout?: IntegerOptional;
4365 /**
4366 * The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible. RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.
4367 */
4368 TimeoutAction?: String;
4369 }
4370 export interface ModifyDBClusterEndpointMessage {
4371 /**
4372 * The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
4373 */
4374 DBClusterEndpointIdentifier: String;
4375 /**
4376 * The type of the endpoint. One of: READER, ANY.
4377 */
4378 EndpointType?: String;
4379 /**
4380 * List of DB instance identifiers that are part of the custom endpoint group.
4381 */
4382 StaticMembers?: StringList;
4383 /**
4384 * List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
4385 */
4386 ExcludedMembers?: StringList;
4387 }
4388 export interface ModifyDBClusterMessage {
4389 /**
4390 * The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster.
4391 */
4392 DBClusterIdentifier: String;
4393 /**
4394 * 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 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2
4395 */
4396 NewDBClusterIdentifier?: String;
4397 /**
4398 * 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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. Default: false
4399 */
4400 ApplyImmediately?: Boolean;
4401 /**
4402 * 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
4403 */
4404 BackupRetentionPeriod?: IntegerOptional;
4405 /**
4406 * The name of the DB cluster parameter group to use for the DB cluster.
4407 */
4408 DBClusterParameterGroupName?: String;
4409 /**
4410 * A list of VPC security groups that the DB cluster will belong to.
4411 */
4412 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
4413 /**
4414 * 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.
4415 */
4416 Port?: IntegerOptional;
4417 /**
4418 * 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.
4419 */
4420 MasterUserPassword?: String;
4421 /**
4422 * A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't 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 can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
4423 */
4424 OptionGroupName?: String;
4425 /**
4426 * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
4427 */
4428 PreferredBackupWindow?: String;
4429 /**
4430 * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
4431 */
4432 PreferredMaintenanceWindow?: String;
4433 /**
4434 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
4435 */
4436 EnableIAMDatabaseAuthentication?: BooleanOptional;
4437 /**
4438 * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
4439 */
4440 BacktrackWindow?: LongOptional;
4441 /**
4442 * The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
4443 */
4444 CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
4445 /**
4446 * The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true. For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.
4447 */
4448 EngineVersion?: String;
4449 /**
4450 * The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
4451 */
4452 ScalingConfiguration?: ScalingConfiguration;
4453 /**
4454 * Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
4455 */
4456 DeletionProtection?: BooleanOptional;
4457 /**
4458 * HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change. A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
4459 */
4460 EnableHttpEndpoint?: BooleanOptional;
4461 /**
4462 * True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false.
4463 */
4464 CopyTagsToSnapshot?: BooleanOptional;
4465 }
4466 export interface ModifyDBClusterParameterGroupMessage {
4467 /**
4468 * The name of the DB cluster parameter group to modify.
4469 */
4470 DBClusterParameterGroupName: String;
4471 /**
4472 * A list of parameters in the DB cluster parameter group to modify.
4473 */
4474 Parameters: ParametersList;
4475 }
4476 export interface ModifyDBClusterResult {
4477 DBCluster?: DBCluster;
4478 }
4479 export interface ModifyDBClusterSnapshotAttributeMessage {
4480 /**
4481 * The identifier for the DB cluster snapshot to modify the attributes for.
4482 */
4483 DBClusterSnapshotIdentifier: String;
4484 /**
4485 * 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.
4486 */
4487 AttributeName: String;
4488 /**
4489 * 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.
4490 */
4491 ValuesToAdd?: AttributeValueList;
4492 /**
4493 * 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.
4494 */
4495 ValuesToRemove?: AttributeValueList;
4496 }
4497 export interface ModifyDBClusterSnapshotAttributeResult {
4498 DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
4499 }
4500 export interface ModifyDBInstanceMessage {
4501 /**
4502 * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
4503 */
4504 DBInstanceIdentifier: String;
4505 /**
4506 * The new amount of storage (in gibibytes) to allocate for the DB instance. For MariaDB, MySQL, Oracle, and PostgreSQL, the 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. For the valid values for allocated storage for each engine, see CreateDBInstance.
4507 */
4508 AllocatedStorage?: IntegerOptional;
4509 /**
4510 * The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request. Default: Uses existing setting
4511 */
4512 DBInstanceClass?: String;
4513 /**
4514 * 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 in the Amazon RDS User Guide. 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: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup
4515 */
4516 DBSubnetGroupName?: String;
4517 /**
4518 * A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: If supplied, must match existing DBSecurityGroups.
4519 */
4520 DBSecurityGroups?: DBSecurityGroupNameList;
4521 /**
4522 * A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds.
4523 */
4524 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
4525 /**
4526 * 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 are 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 in the Amazon RDS User Guide. to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes are applied. Default: false
4527 */
4528 ApplyImmediately?: Boolean;
4529 /**
4530 * The new password for the master user. The password can include any printable ASCII character except "/", """, or "@". Changing this parameter doesn't 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. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. 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.
4531 */
4532 MasterUserPassword?: String;
4533 /**
4534 * The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't 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.
4535 */
4536 DBParameterGroupName?: String;
4537 /**
4538 * 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. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. 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 or later Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5 Can't be set to 0 if the DB instance is a source to Read Replicas
4539 */
4540 BackupRetentionPeriod?: IntegerOptional;
4541 /**
4542 * The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: Must be in the format hh24:mi-hh24:mi Must be in Universal Time Coordinated (UTC) Must not conflict with the preferred maintenance window Must be at least 30 minutes
4543 */
4544 PreferredBackupWindow?: String;
4545 /**
4546 * The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, 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
4547 */
4548 PreferredMaintenanceWindow?: String;
4549 /**
4550 * Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't 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.
4551 */
4552 MultiAZ?: BooleanOptional;
4553 /**
4554 * 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 nondefault 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 information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
4555 */
4556 EngineVersion?: String;
4557 /**
4558 * Indicates that major version upgrades are allowed. Changing this parameter doesn't 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.
4559 */
4560 AllowMajorVersionUpgrade?: Boolean;
4561 /**
4562 * Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't 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.
4563 */
4564 AutoMinorVersionUpgrade?: BooleanOptional;
4565 /**
4566 * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
4567 */
4568 LicenseModel?: String;
4569 /**
4570 * The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting doesn't 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. 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. 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the 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. Default: Uses existing setting
4571 */
4572 Iops?: IntegerOptional;
4573 /**
4574 * Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't 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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
4575 */
4576 OptionGroupName?: String;
4577 /**
4578 * 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 letters, numbers, or hyphens. The first character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
4579 */
4580 NewDBInstanceIdentifier?: String;
4581 /**
4582 * Specifies the storage type to be associated with the DB instance. If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter. 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 is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are 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. Valid values: standard | gp2 | io1 Default: io1 if the Iops parameter is specified, otherwise standard
4583 */
4584 StorageType?: String;
4585 /**
4586 * The ARN from the key store with which to associate the instance for TDE encryption.
4587 */
4588 TdeCredentialArn?: String;
4589 /**
4590 * The password for the given ARN from the key store in order to access the device.
4591 */
4592 TdeCredentialPassword?: String;
4593 /**
4594 * Indicates the certificate that needs to be associated with the instance.
4595 */
4596 CACertificateIdentifier?: String;
4597 /**
4598 * 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.
4599 */
4600 Domain?: String;
4601 /**
4602 * True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.
4603 */
4604 CopyTagsToSnapshot?: BooleanOptional;
4605 /**
4606 * 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
4607 */
4608 MonitoringInterval?: IntegerOptional;
4609 /**
4610 * 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
4611 */
4612 DBPortNumber?: IntegerOptional;
4613 /**
4614 * 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
4615 */
4616 PubliclyAccessible?: BooleanOptional;
4617 /**
4618 * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon 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 in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
4619 */
4620 MonitoringRoleArn?: String;
4621 /**
4622 * The name of the IAM role to use when making API calls to the Directory Service.
4623 */
4624 DomainIAMRoleName?: String;
4625 /**
4626 * 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 in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15
4627 */
4628 PromotionTier?: IntegerOptional;
4629 /**
4630 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster. MySQL For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Default: false
4631 */
4632 EnableIAMDatabaseAuthentication?: BooleanOptional;
4633 /**
4634 * True to enable Performance Insights for the DB instance, and otherwise false. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
4635 */
4636 EnablePerformanceInsights?: BooleanOptional;
4637 /**
4638 * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
4639 */
4640 PerformanceInsightsKMSKeyId?: String;
4641 /**
4642 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
4643 */
4644 PerformanceInsightsRetentionPeriod?: IntegerOptional;
4645 /**
4646 * The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
4647 */
4648 CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
4649 /**
4650 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
4651 */
4652 ProcessorFeatures?: ProcessorFeatureList;
4653 /**
4654 * A value that specifies that the DB instance class of the DB instance uses its default processor features.
4655 */
4656 UseDefaultProcessorFeatures?: BooleanOptional;
4657 /**
4658 * Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.
4659 */
4660 DeletionProtection?: BooleanOptional;
4661 }
4662 export interface ModifyDBInstanceResult {
4663 DBInstance?: DBInstance;
4664 }
4665 export interface ModifyDBParameterGroupMessage {
4666 /**
4667 * The name of the DB parameter group. Constraints: If supplied, must match the name of an existing DBParameterGroup.
4668 */
4669 DBParameterGroupName: String;
4670 /**
4671 * 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.
4672 */
4673 Parameters: ParametersList;
4674 }
4675 export interface ModifyDBSnapshotAttributeMessage {
4676 /**
4677 * The identifier for the DB snapshot to modify the attributes for.
4678 */
4679 DBSnapshotIdentifier: String;
4680 /**
4681 * 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.
4682 */
4683 AttributeName: String;
4684 /**
4685 * 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.
4686 */
4687 ValuesToAdd?: AttributeValueList;
4688 /**
4689 * 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.
4690 */
4691 ValuesToRemove?: AttributeValueList;
4692 }
4693 export interface ModifyDBSnapshotAttributeResult {
4694 DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
4695 }
4696 export interface ModifyDBSnapshotMessage {
4697 /**
4698 * The identifier of the DB snapshot to modify.
4699 */
4700 DBSnapshotIdentifier: String;
4701 /**
4702 * The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. MySQL 5.5.46 (supported for 5.1 DB snapshots) Oracle 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)
4703 */
4704 EngineVersion?: String;
4705 /**
4706 * The option group to identify with the upgraded DB snapshot. You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations in the Amazon RDS User Guide.
4707 */
4708 OptionGroupName?: String;
4709 }
4710 export interface ModifyDBSnapshotResult {
4711 DBSnapshot?: DBSnapshot;
4712 }
4713 export interface ModifyDBSubnetGroupMessage {
4714 /**
4715 * The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
4716 */
4717 DBSubnetGroupName: String;
4718 /**
4719 * The description for the DB subnet group.
4720 */
4721 DBSubnetGroupDescription?: String;
4722 /**
4723 * The EC2 subnet IDs for the DB subnet group.
4724 */
4725 SubnetIds: SubnetIdentifierList;
4726 }
4727 export interface ModifyDBSubnetGroupResult {
4728 DBSubnetGroup?: DBSubnetGroup;
4729 }
4730 export interface ModifyEventSubscriptionMessage {
4731 /**
4732 * The name of the RDS event notification subscription.
4733 */
4734 SubscriptionName: String;
4735 /**
4736 * 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.
4737 */
4738 SnsTopicArn?: String;
4739 /**
4740 * The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
4741 */
4742 SourceType?: String;
4743 /**
4744 * 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.
4745 */
4746 EventCategories?: EventCategoriesList;
4747 /**
4748 * A Boolean value; set to true to activate the subscription.
4749 */
4750 Enabled?: BooleanOptional;
4751 }
4752 export interface ModifyEventSubscriptionResult {
4753 EventSubscription?: EventSubscription;
4754 }
4755 export interface ModifyGlobalClusterMessage {
4756 /**
4757 * The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing global database cluster.
4758 */
4759 GlobalClusterIdentifier?: String;
4760 /**
4761 * The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2
4762 */
4763 NewGlobalClusterIdentifier?: String;
4764 /**
4765 * Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when this value is set to true.
4766 */
4767 DeletionProtection?: BooleanOptional;
4768 }
4769 export interface ModifyGlobalClusterResult {
4770 GlobalCluster?: GlobalCluster;
4771 }
4772 export interface ModifyOptionGroupMessage {
4773 /**
4774 * The name of the option group to be modified. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
4775 */
4776 OptionGroupName: String;
4777 /**
4778 * Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
4779 */
4780 OptionsToInclude?: OptionConfigurationList;
4781 /**
4782 * Options in this list are removed from the option group.
4783 */
4784 OptionsToRemove?: OptionNamesList;
4785 /**
4786 * Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.
4787 */
4788 ApplyImmediately?: Boolean;
4789 }
4790 export interface ModifyOptionGroupResult {
4791 OptionGroup?: OptionGroup;
4792 }
4793 export interface Option {
4794 /**
4795 * The name of the option.
4796 */
4797 OptionName?: String;
4798 /**
4799 * The description of the option.
4800 */
4801 OptionDescription?: String;
4802 /**
4803 * Indicate if this option is persistent.
4804 */
4805 Persistent?: Boolean;
4806 /**
4807 * Indicate if this option is permanent.
4808 */
4809 Permanent?: Boolean;
4810 /**
4811 * If required, the port configured for this option to use.
4812 */
4813 Port?: IntegerOptional;
4814 /**
4815 * The version of the option.
4816 */
4817 OptionVersion?: String;
4818 /**
4819 * The option settings for this option.
4820 */
4821 OptionSettings?: OptionSettingConfigurationList;
4822 /**
4823 * If the option requires access to a port, then this DB security group allows access to the port.
4824 */
4825 DBSecurityGroupMemberships?: DBSecurityGroupMembershipList;
4826 /**
4827 * If the option requires access to a port, then this VPC security group allows access to the port.
4828 */
4829 VpcSecurityGroupMemberships?: VpcSecurityGroupMembershipList;
4830 }
4831 export interface OptionConfiguration {
4832 /**
4833 * The configuration of options to include in a group.
4834 */
4835 OptionName: String;
4836 /**
4837 * The optional port for the option.
4838 */
4839 Port?: IntegerOptional;
4840 /**
4841 * The version for the option.
4842 */
4843 OptionVersion?: String;
4844 /**
4845 * A list of DBSecurityGroupMemebrship name strings used for this option.
4846 */
4847 DBSecurityGroupMemberships?: DBSecurityGroupNameList;
4848 /**
4849 * A list of VpcSecurityGroupMemebrship name strings used for this option.
4850 */
4851 VpcSecurityGroupMemberships?: VpcSecurityGroupIdList;
4852 /**
4853 * The option settings to include in an option group.
4854 */
4855 OptionSettings?: OptionSettingsList;
4856 }
4857 export type OptionConfigurationList = OptionConfiguration[];
4858 export interface OptionGroup {
4859 /**
4860 * Specifies the name of the option group.
4861 */
4862 OptionGroupName?: String;
4863 /**
4864 * Provides a description of the option group.
4865 */
4866 OptionGroupDescription?: String;
4867 /**
4868 * Indicates the name of the engine that this option group can be applied to.
4869 */
4870 EngineName?: String;
4871 /**
4872 * Indicates the major engine version associated with this option group.
4873 */
4874 MajorEngineVersion?: String;
4875 /**
4876 * Indicates what options are available in the option group.
4877 */
4878 Options?: OptionsList;
4879 /**
4880 * 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.
4881 */
4882 AllowsVpcAndNonVpcInstanceMemberships?: Boolean;
4883 /**
4884 * 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.
4885 */
4886 VpcId?: String;
4887 /**
4888 * The Amazon Resource Name (ARN) for the option group.
4889 */
4890 OptionGroupArn?: String;
4891 }
4892 export interface OptionGroupMembership {
4893 /**
4894 * The name of the option group that the instance belongs to.
4895 */
4896 OptionGroupName?: String;
4897 /**
4898 * 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.
4899 */
4900 Status?: String;
4901 }
4902 export type OptionGroupMembershipList = OptionGroupMembership[];
4903 export interface OptionGroupOption {
4904 /**
4905 * The name of the option.
4906 */
4907 Name?: String;
4908 /**
4909 * The description of the option.
4910 */
4911 Description?: String;
4912 /**
4913 * The name of the engine that this option can be applied to.
4914 */
4915 EngineName?: String;
4916 /**
4917 * Indicates the major engine version that the option is available for.
4918 */
4919 MajorEngineVersion?: String;
4920 /**
4921 * The minimum required engine version for the option to be applied.
4922 */
4923 MinimumRequiredMinorEngineVersion?: String;
4924 /**
4925 * Specifies whether the option requires a port.
4926 */
4927 PortRequired?: Boolean;
4928 /**
4929 * If the option requires a port, specifies the default port for the option.
4930 */
4931 DefaultPort?: IntegerOptional;
4932 /**
4933 * The options that are prerequisites for this option.
4934 */
4935 OptionsDependedOn?: OptionsDependedOn;
4936 /**
4937 * The options that conflict with this option.
4938 */
4939 OptionsConflictsWith?: OptionsConflictsWith;
4940 /**
4941 * 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.
4942 */
4943 Persistent?: Boolean;
4944 /**
4945 * 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.
4946 */
4947 Permanent?: Boolean;
4948 /**
4949 * If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
4950 */
4951 RequiresAutoMinorEngineVersionUpgrade?: Boolean;
4952 /**
4953 * If true, you can only use this option with a DB instance that is in a VPC.
4954 */
4955 VpcOnly?: Boolean;
4956 /**
4957 * If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
4958 */
4959 SupportsOptionVersionDowngrade?: BooleanOptional;
4960 /**
4961 * The option settings that are available (and the default value) for each option in an option group.
4962 */
4963 OptionGroupOptionSettings?: OptionGroupOptionSettingsList;
4964 /**
4965 * The versions that are available for the option.
4966 */
4967 OptionGroupOptionVersions?: OptionGroupOptionVersionsList;
4968 }
4969 export interface OptionGroupOptionSetting {
4970 /**
4971 * The name of the option group option.
4972 */
4973 SettingName?: String;
4974 /**
4975 * The description of the option group option.
4976 */
4977 SettingDescription?: String;
4978 /**
4979 * The default value for the option group option.
4980 */
4981 DefaultValue?: String;
4982 /**
4983 * The DB engine specific parameter type for the option group option.
4984 */
4985 ApplyType?: String;
4986 /**
4987 * Indicates the acceptable values for the option group option.
4988 */
4989 AllowedValues?: String;
4990 /**
4991 * Boolean value where true indicates that this option group option can be changed from the default value.
4992 */
4993 IsModifiable?: Boolean;
4994 /**
4995 * Boolean value where true indicates that a value must be specified for this option setting of the option group option.
4996 */
4997 IsRequired?: Boolean;
4998 /**
4999 * The minimum DB engine version required for the corresponding allowed value for this option setting.
5000 */
5001 MinimumEngineVersionPerAllowedValue?: MinimumEngineVersionPerAllowedValueList;
5002 }
5003 export type OptionGroupOptionSettingsList = OptionGroupOptionSetting[];
5004 export type OptionGroupOptionVersionsList = OptionVersion[];
5005 export type OptionGroupOptionsList = OptionGroupOption[];
5006 export interface OptionGroupOptionsMessage {
5007 OptionGroupOptions?: OptionGroupOptionsList;
5008 /**
5009 * 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.
5010 */
5011 Marker?: String;
5012 }
5013 export interface OptionGroups {
5014 /**
5015 * List of option groups.
5016 */
5017 OptionGroupsList?: OptionGroupsList;
5018 /**
5019 * 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.
5020 */
5021 Marker?: String;
5022 }
5023 export type OptionGroupsList = OptionGroup[];
5024 export type OptionNamesList = String[];
5025 export interface OptionSetting {
5026 /**
5027 * The name of the option that has settings that you can set.
5028 */
5029 Name?: String;
5030 /**
5031 * The current value of the option setting.
5032 */
5033 Value?: String;
5034 /**
5035 * The default value of the option setting.
5036 */
5037 DefaultValue?: String;
5038 /**
5039 * The description of the option setting.
5040 */
5041 Description?: String;
5042 /**
5043 * The DB engine specific parameter type.
5044 */
5045 ApplyType?: String;
5046 /**
5047 * The data type of the option setting.
5048 */
5049 DataType?: String;
5050 /**
5051 * The allowed values of the option setting.
5052 */
5053 AllowedValues?: String;
5054 /**
5055 * A Boolean value that, when true, indicates the option setting can be modified from the default.
5056 */
5057 IsModifiable?: Boolean;
5058 /**
5059 * Indicates if the option setting is part of a collection.
5060 */
5061 IsCollection?: Boolean;
5062 }
5063 export type OptionSettingConfigurationList = OptionSetting[];
5064 export type OptionSettingsList = OptionSetting[];
5065 export interface OptionVersion {
5066 /**
5067 * The version of the option.
5068 */
5069 Version?: String;
5070 /**
5071 * True if the version is the default version of the option, and otherwise false.
5072 */
5073 IsDefault?: Boolean;
5074 }
5075 export type OptionsConflictsWith = String[];
5076 export type OptionsDependedOn = String[];
5077 export type OptionsList = Option[];
5078 export interface OrderableDBInstanceOption {
5079 /**
5080 * The engine type of a DB instance.
5081 */
5082 Engine?: String;
5083 /**
5084 * The engine version of a DB instance.
5085 */
5086 EngineVersion?: String;
5087 /**
5088 * The DB instance class for a DB instance.
5089 */
5090 DBInstanceClass?: String;
5091 /**
5092 * The license model for a DB instance.
5093 */
5094 LicenseModel?: String;
5095 /**
5096 * A list of Availability Zones for a DB instance.
5097 */
5098 AvailabilityZones?: AvailabilityZoneList;
5099 /**
5100 * Indicates whether a DB instance is Multi-AZ capable.
5101 */
5102 MultiAZCapable?: Boolean;
5103 /**
5104 * Indicates whether a DB instance can have a Read Replica.
5105 */
5106 ReadReplicaCapable?: Boolean;
5107 /**
5108 * Indicates whether a DB instance is in a VPC.
5109 */
5110 Vpc?: Boolean;
5111 /**
5112 * Indicates whether a DB instance supports encrypted storage.
5113 */
5114 SupportsStorageEncryption?: Boolean;
5115 /**
5116 * Indicates the storage type for a DB instance.
5117 */
5118 StorageType?: String;
5119 /**
5120 * Indicates whether a DB instance supports provisioned IOPS.
5121 */
5122 SupportsIops?: Boolean;
5123 /**
5124 * Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
5125 */
5126 SupportsEnhancedMonitoring?: Boolean;
5127 /**
5128 * Indicates whether a DB instance supports IAM database authentication.
5129 */
5130 SupportsIAMDatabaseAuthentication?: Boolean;
5131 /**
5132 * True if a DB instance supports Performance Insights, otherwise false.
5133 */
5134 SupportsPerformanceInsights?: Boolean;
5135 /**
5136 * Minimum storage size for a DB instance.
5137 */
5138 MinStorageSize?: IntegerOptional;
5139 /**
5140 * Maximum storage size for a DB instance.
5141 */
5142 MaxStorageSize?: IntegerOptional;
5143 /**
5144 * Minimum total provisioned IOPS for a DB instance.
5145 */
5146 MinIopsPerDbInstance?: IntegerOptional;
5147 /**
5148 * Maximum total provisioned IOPS for a DB instance.
5149 */
5150 MaxIopsPerDbInstance?: IntegerOptional;
5151 /**
5152 * Minimum provisioned IOPS per GiB for a DB instance.
5153 */
5154 MinIopsPerGib?: DoubleOptional;
5155 /**
5156 * Maximum provisioned IOPS per GiB for a DB instance.
5157 */
5158 MaxIopsPerGib?: DoubleOptional;
5159 /**
5160 * A list of the available processor features for the DB instance class of a DB instance.
5161 */
5162 AvailableProcessorFeatures?: AvailableProcessorFeatureList;
5163 /**
5164 * A list of the supported DB engine modes.
5165 */
5166 SupportedEngineModes?: EngineModeList;
5167 }
5168 export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[];
5169 export interface OrderableDBInstanceOptionsMessage {
5170 /**
5171 * An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
5172 */
5173 OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList;
5174 /**
5175 * 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 .
5176 */
5177 Marker?: String;
5178 }
5179 export interface Parameter {
5180 /**
5181 * Specifies the name of the parameter.
5182 */
5183 ParameterName?: String;
5184 /**
5185 * Specifies the value of the parameter.
5186 */
5187 ParameterValue?: String;
5188 /**
5189 * Provides a description of the parameter.
5190 */
5191 Description?: String;
5192 /**
5193 * Indicates the source of the parameter value.
5194 */
5195 Source?: String;
5196 /**
5197 * Specifies the engine specific parameters type.
5198 */
5199 ApplyType?: String;
5200 /**
5201 * Specifies the valid data type for the parameter.
5202 */
5203 DataType?: String;
5204 /**
5205 * Specifies the valid range of values for the parameter.
5206 */
5207 AllowedValues?: String;
5208 /**
5209 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
5210 */
5211 IsModifiable?: Boolean;
5212 /**
5213 * The earliest engine version to which the parameter can apply.
5214 */
5215 MinimumEngineVersion?: String;
5216 /**
5217 * Indicates when to apply parameter updates.
5218 */
5219 ApplyMethod?: ApplyMethod;
5220 /**
5221 * The valid DB engine modes.
5222 */
5223 SupportedEngineModes?: EngineModeList;
5224 }
5225 export type ParametersList = Parameter[];
5226 export interface PendingCloudwatchLogsExports {
5227 /**
5228 * Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
5229 */
5230 LogTypesToEnable?: LogTypeList;
5231 /**
5232 * Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
5233 */
5234 LogTypesToDisable?: LogTypeList;
5235 }
5236 export interface PendingMaintenanceAction {
5237 /**
5238 * The type of pending maintenance action that is available for the resource. Valid actions are system-update and db-upgrade.
5239 */
5240 Action?: String;
5241 /**
5242 * The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.
5243 */
5244 AutoAppliedAfterDate?: TStamp;
5245 /**
5246 * The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.
5247 */
5248 ForcedApplyDate?: TStamp;
5249 /**
5250 * Indicates the type of opt-in request that has been received for the resource.
5251 */
5252 OptInStatus?: String;
5253 /**
5254 * The effective date when the pending maintenance action is 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.
5255 */
5256 CurrentApplyDate?: TStamp;
5257 /**
5258 * A description providing more detail about the maintenance action.
5259 */
5260 Description?: String;
5261 }
5262 export type PendingMaintenanceActionDetails = PendingMaintenanceAction[];
5263 export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[];
5264 export interface PendingMaintenanceActionsMessage {
5265 /**
5266 * A list of the pending maintenance actions for the resource.
5267 */
5268 PendingMaintenanceActions?: PendingMaintenanceActions;
5269 /**
5270 * 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.
5271 */
5272 Marker?: String;
5273 }
5274 export interface PendingModifiedValues {
5275 /**
5276 * Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
5277 */
5278 DBInstanceClass?: String;
5279 /**
5280 * Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
5281 */
5282 AllocatedStorage?: IntegerOptional;
5283 /**
5284 * Contains the pending or currently-in-progress change of the master credentials for the DB instance.
5285 */
5286 MasterUserPassword?: String;
5287 /**
5288 * Specifies the pending port for the DB instance.
5289 */
5290 Port?: IntegerOptional;
5291 /**
5292 * Specifies the pending number of days for which automated backups are retained.
5293 */
5294 BackupRetentionPeriod?: IntegerOptional;
5295 /**
5296 * Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
5297 */
5298 MultiAZ?: BooleanOptional;
5299 /**
5300 * Indicates the database engine version.
5301 */
5302 EngineVersion?: String;
5303 /**
5304 * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
5305 */
5306 LicenseModel?: String;
5307 /**
5308 * Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
5309 */
5310 Iops?: IntegerOptional;
5311 /**
5312 * Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
5313 */
5314 DBInstanceIdentifier?: String;
5315 /**
5316 * Specifies the storage type to be associated with the DB instance.
5317 */
5318 StorageType?: String;
5319 /**
5320 * Specifies the identifier of the CA certificate for the DB instance.
5321 */
5322 CACertificateIdentifier?: String;
5323 /**
5324 * The new DB subnet group for the DB instance.
5325 */
5326 DBSubnetGroupName?: String;
5327 PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports;
5328 /**
5329 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
5330 */
5331 ProcessorFeatures?: ProcessorFeatureList;
5332 }
5333 export interface ProcessorFeature {
5334 /**
5335 * The name of the processor feature. Valid names are coreCount and threadsPerCore.
5336 */
5337 Name?: String;
5338 /**
5339 * The value of a processor feature name.
5340 */
5341 Value?: String;
5342 }
5343 export type ProcessorFeatureList = ProcessorFeature[];
5344 export interface PromoteReadReplicaDBClusterMessage {
5345 /**
5346 * The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster Read Replica. Example: my-cluster-replica1
5347 */
5348 DBClusterIdentifier: String;
5349 }
5350 export interface PromoteReadReplicaDBClusterResult {
5351 DBCluster?: DBCluster;
5352 }
5353 export interface PromoteReadReplicaMessage {
5354 /**
5355 * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing Read Replica DB instance. Example: mydbinstance
5356 */
5357 DBInstanceIdentifier: String;
5358 /**
5359 * 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
5360 */
5361 BackupRetentionPeriod?: IntegerOptional;
5362 /**
5363 * The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS 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. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
5364 */
5365 PreferredBackupWindow?: String;
5366 }
5367 export interface PromoteReadReplicaResult {
5368 DBInstance?: DBInstance;
5369 }
5370 export interface PurchaseReservedDBInstancesOfferingMessage {
5371 /**
5372 * The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
5373 */
5374 ReservedDBInstancesOfferingId: String;
5375 /**
5376 * Customer-specified identifier to track this reservation. Example: myreservationID
5377 */
5378 ReservedDBInstanceId?: String;
5379 /**
5380 * The number of instances to reserve. Default: 1
5381 */
5382 DBInstanceCount?: IntegerOptional;
5383 Tags?: TagList;
5384 }
5385 export interface PurchaseReservedDBInstancesOfferingResult {
5386 ReservedDBInstance?: ReservedDBInstance;
5387 }
5388 export interface Range {
5389 /**
5390 * The minimum value in the range.
5391 */
5392 From?: Integer;
5393 /**
5394 * The maximum value in the range.
5395 */
5396 To?: Integer;
5397 /**
5398 * The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
5399 */
5400 Step?: IntegerOptional;
5401 }
5402 export type RangeList = Range[];
5403 export type ReadReplicaDBClusterIdentifierList = String[];
5404 export type ReadReplicaDBInstanceIdentifierList = String[];
5405 export type ReadReplicaIdentifierList = String[];
5406 export type ReadersArnList = String[];
5407 export interface RebootDBInstanceMessage {
5408 /**
5409 * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
5410 */
5411 DBInstanceIdentifier: String;
5412 /**
5413 * When true, the reboot is conducted through a MultiAZ failover. Constraint: You can't specify true if the instance is not configured for MultiAZ.
5414 */
5415 ForceFailover?: BooleanOptional;
5416 }
5417 export interface RebootDBInstanceResult {
5418 DBInstance?: DBInstance;
5419 }
5420 export interface RecurringCharge {
5421 /**
5422 * The amount of the recurring charge.
5423 */
5424 RecurringChargeAmount?: Double;
5425 /**
5426 * The frequency of the recurring charge.
5427 */
5428 RecurringChargeFrequency?: String;
5429 }
5430 export type RecurringChargeList = RecurringCharge[];
5431 export interface RemoveFromGlobalClusterMessage {
5432 /**
5433 * The cluster identifier to detach from the Aurora global database cluster.
5434 */
5435 GlobalClusterIdentifier?: String;
5436 /**
5437 * The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
5438 */
5439 DbClusterIdentifier?: String;
5440 }
5441 export interface RemoveFromGlobalClusterResult {
5442 GlobalCluster?: GlobalCluster;
5443 }
5444 export interface RemoveRoleFromDBClusterMessage {
5445 /**
5446 * The name of the DB cluster to disassociate the IAM role from.
5447 */
5448 DBClusterIdentifier: String;
5449 /**
5450 * The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
5451 */
5452 RoleArn: String;
5453 }
5454 export interface RemoveRoleFromDBInstanceMessage {
5455 /**
5456 * The name of the DB instance to disassociate the IAM role from.
5457 */
5458 DBInstanceIdentifier: String;
5459 /**
5460 * The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
5461 */
5462 RoleArn: String;
5463 /**
5464 * The name of the feature for the DB instance that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.
5465 */
5466 FeatureName: String;
5467 }
5468 export interface RemoveSourceIdentifierFromSubscriptionMessage {
5469 /**
5470 * The name of the RDS event notification subscription you want to remove a source identifier from.
5471 */
5472 SubscriptionName: String;
5473 /**
5474 * 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.
5475 */
5476 SourceIdentifier: String;
5477 }
5478 export interface RemoveSourceIdentifierFromSubscriptionResult {
5479 EventSubscription?: EventSubscription;
5480 }
5481 export interface RemoveTagsFromResourceMessage {
5482 /**
5483 * The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
5484 */
5485 ResourceName: String;
5486 /**
5487 * The tag key (name) of the tag to be removed.
5488 */
5489 TagKeys: KeyList;
5490 }
5491 export interface ReservedDBInstance {
5492 /**
5493 * The unique identifier for the reservation.
5494 */
5495 ReservedDBInstanceId?: String;
5496 /**
5497 * The offering identifier.
5498 */
5499 ReservedDBInstancesOfferingId?: String;
5500 /**
5501 * The DB instance class for the reserved DB instance.
5502 */
5503 DBInstanceClass?: String;
5504 /**
5505 * The time the reservation started.
5506 */
5507 StartTime?: TStamp;
5508 /**
5509 * The duration of the reservation in seconds.
5510 */
5511 Duration?: Integer;
5512 /**
5513 * The fixed price charged for this reserved DB instance.
5514 */
5515 FixedPrice?: Double;
5516 /**
5517 * The hourly price charged for this reserved DB instance.
5518 */
5519 UsagePrice?: Double;
5520 /**
5521 * The currency code for the reserved DB instance.
5522 */
5523 CurrencyCode?: String;
5524 /**
5525 * The number of reserved DB instances.
5526 */
5527 DBInstanceCount?: Integer;
5528 /**
5529 * The description of the reserved DB instance.
5530 */
5531 ProductDescription?: String;
5532 /**
5533 * The offering type of this reserved DB instance.
5534 */
5535 OfferingType?: String;
5536 /**
5537 * Indicates if the reservation applies to Multi-AZ deployments.
5538 */
5539 MultiAZ?: Boolean;
5540 /**
5541 * The state of the reserved DB instance.
5542 */
5543 State?: String;
5544 /**
5545 * The recurring price charged to run this reserved DB instance.
5546 */
5547 RecurringCharges?: RecurringChargeList;
5548 /**
5549 * The Amazon Resource Name (ARN) for the reserved DB instance.
5550 */
5551 ReservedDBInstanceArn?: String;
5552 }
5553 export type ReservedDBInstanceList = ReservedDBInstance[];
5554 export interface ReservedDBInstanceMessage {
5555 /**
5556 * 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.
5557 */
5558 Marker?: String;
5559 /**
5560 * A list of reserved DB instances.
5561 */
5562 ReservedDBInstances?: ReservedDBInstanceList;
5563 }
5564 export interface ReservedDBInstancesOffering {
5565 /**
5566 * The offering identifier.
5567 */
5568 ReservedDBInstancesOfferingId?: String;
5569 /**
5570 * The DB instance class for the reserved DB instance.
5571 */
5572 DBInstanceClass?: String;
5573 /**
5574 * The duration of the offering in seconds.
5575 */
5576 Duration?: Integer;
5577 /**
5578 * The fixed price charged for this offering.
5579 */
5580 FixedPrice?: Double;
5581 /**
5582 * The hourly price charged for this offering.
5583 */
5584 UsagePrice?: Double;
5585 /**
5586 * The currency code for the reserved DB instance offering.
5587 */
5588 CurrencyCode?: String;
5589 /**
5590 * The database engine used by the offering.
5591 */
5592 ProductDescription?: String;
5593 /**
5594 * The offering type.
5595 */
5596 OfferingType?: String;
5597 /**
5598 * Indicates if the offering applies to Multi-AZ deployments.
5599 */
5600 MultiAZ?: Boolean;
5601 /**
5602 * The recurring price charged to run this reserved DB instance.
5603 */
5604 RecurringCharges?: RecurringChargeList;
5605 }
5606 export type ReservedDBInstancesOfferingList = ReservedDBInstancesOffering[];
5607 export interface ReservedDBInstancesOfferingMessage {
5608 /**
5609 * 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.
5610 */
5611 Marker?: String;
5612 /**
5613 * A list of reserved DB instance offerings.
5614 */
5615 ReservedDBInstancesOfferings?: ReservedDBInstancesOfferingList;
5616 }
5617 export interface ResetDBClusterParameterGroupMessage {
5618 /**
5619 * The name of the DB cluster parameter group to reset.
5620 */
5621 DBClusterParameterGroupName: String;
5622 /**
5623 * 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 can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
5624 */
5625 ResetAllParameters?: Boolean;
5626 /**
5627 * A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.
5628 */
5629 Parameters?: ParametersList;
5630 }
5631 export interface ResetDBParameterGroupMessage {
5632 /**
5633 * The name of the DB parameter group. Constraints: Must match the name of an existing DBParameterGroup.
5634 */
5635 DBParameterGroupName: String;
5636 /**
5637 * Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values. Default: true
5638 */
5639 ResetAllParameters?: Boolean;
5640 /**
5641 * To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. 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
5642 */
5643 Parameters?: ParametersList;
5644 }
5645 export interface ResourcePendingMaintenanceActions {
5646 /**
5647 * The ARN of the resource that has pending maintenance actions.
5648 */
5649 ResourceIdentifier?: String;
5650 /**
5651 * A list that provides details about the pending maintenance actions for the resource.
5652 */
5653 PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails;
5654 }
5655 export interface RestoreDBClusterFromS3Message {
5656 /**
5657 * A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
5658 */
5659 AvailabilityZones?: AvailabilityZones;
5660 /**
5661 * 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
5662 */
5663 BackupRetentionPeriod?: IntegerOptional;
5664 /**
5665 * A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
5666 */
5667 CharacterSetName?: String;
5668 /**
5669 * The database name for the restored DB cluster.
5670 */
5671 DatabaseName?: String;
5672 /**
5673 * The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter is isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
5674 */
5675 DBClusterIdentifier: String;
5676 /**
5677 * The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
5678 */
5679 DBClusterParameterGroupName?: String;
5680 /**
5681 * A list of EC2 VPC security groups to associate with the restored DB cluster.
5682 */
5683 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
5684 /**
5685 * A DB subnet group to associate with the restored DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
5686 */
5687 DBSubnetGroupName?: String;
5688 /**
5689 * The name of the database engine to be used for the restored DB cluster. Valid Values: aurora, aurora-postgresql
5690 */
5691 Engine: String;
5692 /**
5693 * The version number of the database engine to use. Aurora MySQL Example: 5.6.10a Aurora PostgreSQL Example: 9.6.3
5694 */
5695 EngineVersion?: String;
5696 /**
5697 * The port number on which the instances in the restored DB cluster accept connections. Default: 3306
5698 */
5699 Port?: IntegerOptional;
5700 /**
5701 * The name of the master user for the restored DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
5702 */
5703 MasterUsername: String;
5704 /**
5705 * 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.
5706 */
5707 MasterUserPassword: String;
5708 /**
5709 * A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
5710 */
5711 OptionGroupName?: String;
5712 /**
5713 * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
5714 */
5715 PreferredBackupWindow?: String;
5716 /**
5717 * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
5718 */
5719 PreferredMaintenanceWindow?: String;
5720 Tags?: TagList;
5721 /**
5722 * Specifies whether the restored DB cluster is encrypted.
5723 */
5724 StorageEncrypted?: BooleanOptional;
5725 /**
5726 * The AWS 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.
5727 */
5728 KmsKeyId?: String;
5729 /**
5730 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
5731 */
5732 EnableIAMDatabaseAuthentication?: BooleanOptional;
5733 /**
5734 * The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: mysql
5735 */
5736 SourceEngine: String;
5737 /**
5738 * 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
5739 */
5740 SourceEngineVersion: String;
5741 /**
5742 * The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
5743 */
5744 S3BucketName: String;
5745 /**
5746 * 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.
5747 */
5748 S3Prefix?: String;
5749 /**
5750 * 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.
5751 */
5752 S3IngestionRoleArn: String;
5753 /**
5754 * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
5755 */
5756 BacktrackWindow?: LongOptional;
5757 /**
5758 * The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
5759 */
5760 EnableCloudwatchLogsExports?: LogTypeList;
5761 /**
5762 * Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
5763 */
5764 DeletionProtection?: BooleanOptional;
5765 /**
5766 * True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.
5767 */
5768 CopyTagsToSnapshot?: BooleanOptional;
5769 }
5770 export interface RestoreDBClusterFromS3Result {
5771 DBCluster?: DBCluster;
5772 }
5773 export interface RestoreDBClusterFromSnapshotMessage {
5774 /**
5775 * Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
5776 */
5777 AvailabilityZones?: AvailabilityZones;
5778 /**
5779 * The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
5780 */
5781 DBClusterIdentifier: String;
5782 /**
5783 * The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing Snapshot.
5784 */
5785 SnapshotIdentifier: String;
5786 /**
5787 * 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
5788 */
5789 Engine: String;
5790 /**
5791 * The version of the database engine to use for the new DB cluster.
5792 */
5793 EngineVersion?: String;
5794 /**
5795 * The port number on which the new DB cluster accepts connections. Constraints: This value must be 1150-65535 Default: The same port as the original DB cluster.
5796 */
5797 Port?: IntegerOptional;
5798 /**
5799 * The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DB subnet group. Example: mySubnetgroup
5800 */
5801 DBSubnetGroupName?: String;
5802 /**
5803 * The database name for the restored DB cluster.
5804 */
5805 DatabaseName?: String;
5806 /**
5807 * The name of the option group to use for the restored DB cluster.
5808 */
5809 OptionGroupName?: String;
5810 /**
5811 * A list of VPC security groups that the new DB cluster will belong to.
5812 */
5813 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
5814 /**
5815 * The tags to be assigned to the restored DB cluster.
5816 */
5817 Tags?: TagList;
5818 /**
5819 * The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
5820 */
5821 KmsKeyId?: String;
5822 /**
5823 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
5824 */
5825 EnableIAMDatabaseAuthentication?: BooleanOptional;
5826 /**
5827 * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
5828 */
5829 BacktrackWindow?: LongOptional;
5830 /**
5831 * The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
5832 */
5833 EnableCloudwatchLogsExports?: LogTypeList;
5834 /**
5835 * The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
5836 */
5837 EngineMode?: String;
5838 /**
5839 * For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
5840 */
5841 ScalingConfiguration?: ScalingConfiguration;
5842 /**
5843 * The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing default DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
5844 */
5845 DBClusterParameterGroupName?: String;
5846 /**
5847 * Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
5848 */
5849 DeletionProtection?: BooleanOptional;
5850 /**
5851 * True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.
5852 */
5853 CopyTagsToSnapshot?: BooleanOptional;
5854 }
5855 export interface RestoreDBClusterFromSnapshotResult {
5856 DBCluster?: DBCluster;
5857 }
5858 export interface RestoreDBClusterToPointInTimeMessage {
5859 /**
5860 * The name of the new DB cluster to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
5861 */
5862 DBClusterIdentifier: String;
5863 /**
5864 * The type of restore to be performed. You can specify one of the following values: full-copy - The new DB cluster is restored as a full copy of the source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
5865 */
5866 RestoreType?: String;
5867 /**
5868 * The identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster.
5869 */
5870 SourceDBClusterIdentifier: String;
5871 /**
5872 * 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 Must be specified if UseLatestRestorableTime parameter is not provided Can't be specified if UseLatestRestorableTime parameter is true Can't be specified if RestoreType parameter is copy-on-write Example: 2015-03-07T23:45:00Z
5873 */
5874 RestoreToTime?: TStamp;
5875 /**
5876 * A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Can't be specified if RestoreToTime parameter is provided.
5877 */
5878 UseLatestRestorableTime?: Boolean;
5879 /**
5880 * The port number on which the new DB cluster accepts connections. Constraints: A value from 1150-65535. Default: The default port for the engine.
5881 */
5882 Port?: IntegerOptional;
5883 /**
5884 * The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
5885 */
5886 DBSubnetGroupName?: String;
5887 /**
5888 * The name of the option group for the new DB cluster.
5889 */
5890 OptionGroupName?: String;
5891 /**
5892 * A list of VPC security groups that the new DB cluster belongs to.
5893 */
5894 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
5895 Tags?: TagList;
5896 /**
5897 * The AWS 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 is encrypted with the KMS key identified by the KmsKeyId parameter. If you don't specify a value for the KmsKeyId parameter, then the following occurs: 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 not encrypted, then the restore request is rejected.
5898 */
5899 KmsKeyId?: String;
5900 /**
5901 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
5902 */
5903 EnableIAMDatabaseAuthentication?: BooleanOptional;
5904 /**
5905 * The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
5906 */
5907 BacktrackWindow?: LongOptional;
5908 /**
5909 * The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
5910 */
5911 EnableCloudwatchLogsExports?: LogTypeList;
5912 /**
5913 * The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
5914 */
5915 DBClusterParameterGroupName?: String;
5916 /**
5917 * Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
5918 */
5919 DeletionProtection?: BooleanOptional;
5920 /**
5921 * True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.
5922 */
5923 CopyTagsToSnapshot?: BooleanOptional;
5924 }
5925 export interface RestoreDBClusterToPointInTimeResult {
5926 DBCluster?: DBCluster;
5927 }
5928 export interface RestoreDBInstanceFromDBSnapshotMessage {
5929 /**
5930 * Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 numbers, letters, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
5931 */
5932 DBInstanceIdentifier: String;
5933 /**
5934 * The identifier for the DB snapshot to restore from. Constraints: Must match the identifier of an existing DBSnapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
5935 */
5936 DBSnapshotIdentifier: String;
5937 /**
5938 * The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.
5939 */
5940 DBInstanceClass?: String;
5941 /**
5942 * The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be 1150-65535
5943 */
5944 Port?: IntegerOptional;
5945 /**
5946 * The EC2 Availability Zone that the DB instance is created in. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a
5947 */
5948 AvailabilityZone?: String;
5949 /**
5950 * The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
5951 */
5952 DBSubnetGroupName?: String;
5953 /**
5954 * Specifies if the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
5955 */
5956 MultiAZ?: BooleanOptional;
5957 /**
5958 * 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. For more information, see CreateDBInstance.
5959 */
5960 PubliclyAccessible?: BooleanOptional;
5961 /**
5962 * Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
5963 */
5964 AutoMinorVersionUpgrade?: BooleanOptional;
5965 /**
5966 * License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
5967 */
5968 LicenseModel?: String;
5969 /**
5970 * The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
5971 */
5972 DBName?: String;
5973 /**
5974 * The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
5975 */
5976 Engine?: String;
5977 /**
5978 * 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 is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts. The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: Must be an integer greater than 1000.
5979 */
5980 Iops?: IntegerOptional;
5981 /**
5982 * 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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
5983 */
5984 OptionGroupName?: String;
5985 Tags?: TagList;
5986 /**
5987 * 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
5988 */
5989 StorageType?: String;
5990 /**
5991 * The ARN from the key store with which to associate the instance for TDE encryption.
5992 */
5993 TdeCredentialArn?: String;
5994 /**
5995 * The password for the given ARN from the key store in order to access the device.
5996 */
5997 TdeCredentialPassword?: String;
5998 /**
5999 * 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.
6000 */
6001 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
6002 /**
6003 * Specify the Active Directory Domain to restore the instance in.
6004 */
6005 Domain?: String;
6006 /**
6007 * True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false.
6008 */
6009 CopyTagsToSnapshot?: BooleanOptional;
6010 /**
6011 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
6012 */
6013 DomainIAMRoleName?: String;
6014 /**
6015 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Default: false
6016 */
6017 EnableIAMDatabaseAuthentication?: BooleanOptional;
6018 /**
6019 * The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
6020 */
6021 EnableCloudwatchLogsExports?: LogTypeList;
6022 /**
6023 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
6024 */
6025 ProcessorFeatures?: ProcessorFeatureList;
6026 /**
6027 * A value that specifies that the DB instance class of the DB instance uses its default processor features.
6028 */
6029 UseDefaultProcessorFeatures?: BooleanOptional;
6030 /**
6031 * 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 is used. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
6032 */
6033 DBParameterGroupName?: String;
6034 /**
6035 * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.
6036 */
6037 DeletionProtection?: BooleanOptional;
6038 }
6039 export interface RestoreDBInstanceFromDBSnapshotResult {
6040 DBInstance?: DBInstance;
6041 }
6042 export interface RestoreDBInstanceFromS3Message {
6043 /**
6044 * The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
6045 */
6046 DBName?: String;
6047 /**
6048 * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
6049 */
6050 DBInstanceIdentifier: String;
6051 /**
6052 * The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
6053 */
6054 AllocatedStorage?: IntegerOptional;
6055 /**
6056 * The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Importing from Amazon S3 is not supported on the db.t2.micro DB instance class.
6057 */
6058 DBInstanceClass: String;
6059 /**
6060 * The name of the database engine to be used for this instance. Valid Values: mysql
6061 */
6062 Engine: String;
6063 /**
6064 * The name for the master user. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
6065 */
6066 MasterUsername?: String;
6067 /**
6068 * The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
6069 */
6070 MasterUserPassword?: String;
6071 /**
6072 * A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
6073 */
6074 DBSecurityGroups?: DBSecurityGroupNameList;
6075 /**
6076 * A list of VPC security groups to associate with this DB instance.
6077 */
6078 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
6079 /**
6080 * The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.
6081 */
6082 AvailabilityZone?: String;
6083 /**
6084 * A DB subnet group to associate with this DB instance.
6085 */
6086 DBSubnetGroupName?: String;
6087 /**
6088 * The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred backup window. Must be at least 30 minutes.
6089 */
6090 PreferredMaintenanceWindow?: String;
6091 /**
6092 * The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.
6093 */
6094 DBParameterGroupName?: String;
6095 /**
6096 * The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
6097 */
6098 BackupRetentionPeriod?: IntegerOptional;
6099 /**
6100 * The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
6101 */
6102 PreferredBackupWindow?: String;
6103 /**
6104 * The port number on which the database accepts connections. Type: Integer Valid Values: 1150-65535 Default: 3306
6105 */
6106 Port?: IntegerOptional;
6107 /**
6108 * Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can't set the AvailabilityZone parameter.
6109 */
6110 MultiAZ?: BooleanOptional;
6111 /**
6112 * The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
6113 */
6114 EngineVersion?: String;
6115 /**
6116 * True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false. Default: true
6117 */
6118 AutoMinorVersionUpgrade?: BooleanOptional;
6119 /**
6120 * The license model for this DB instance. Use general-public-license.
6121 */
6122 LicenseModel?: String;
6123 /**
6124 * The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
6125 */
6126 Iops?: IntegerOptional;
6127 /**
6128 * The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
6129 */
6130 OptionGroupName?: String;
6131 /**
6132 * 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. For more information, see CreateDBInstance.
6133 */
6134 PubliclyAccessible?: BooleanOptional;
6135 /**
6136 * A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
6137 */
6138 Tags?: TagList;
6139 /**
6140 * 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
6141 */
6142 StorageType?: String;
6143 /**
6144 * Specifies whether the new DB instance is encrypted or not.
6145 */
6146 StorageEncrypted?: BooleanOptional;
6147 /**
6148 * The AWS 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.
6149 */
6150 KmsKeyId?: String;
6151 /**
6152 * True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. Default: false.
6153 */
6154 CopyTagsToSnapshot?: BooleanOptional;
6155 /**
6156 * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 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 Default: 0
6157 */
6158 MonitoringInterval?: IntegerOptional;
6159 /**
6160 * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
6161 */
6162 MonitoringRoleArn?: String;
6163 /**
6164 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
6165 */
6166 EnableIAMDatabaseAuthentication?: BooleanOptional;
6167 /**
6168 * The name of the engine of your source database. Valid Values: mysql
6169 */
6170 SourceEngine: String;
6171 /**
6172 * The engine version of your source database. Valid Values: 5.6
6173 */
6174 SourceEngineVersion: String;
6175 /**
6176 * The name of your Amazon S3 bucket that contains your database backup file.
6177 */
6178 S3BucketName: String;
6179 /**
6180 * The prefix of your Amazon S3 bucket.
6181 */
6182 S3Prefix?: String;
6183 /**
6184 * An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
6185 */
6186 S3IngestionRoleArn: String;
6187 /**
6188 * True to enable Performance Insights for the DB instance, and otherwise false. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
6189 */
6190 EnablePerformanceInsights?: BooleanOptional;
6191 /**
6192 * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
6193 */
6194 PerformanceInsightsKMSKeyId?: String;
6195 /**
6196 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
6197 */
6198 PerformanceInsightsRetentionPeriod?: IntegerOptional;
6199 /**
6200 * The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
6201 */
6202 EnableCloudwatchLogsExports?: LogTypeList;
6203 /**
6204 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
6205 */
6206 ProcessorFeatures?: ProcessorFeatureList;
6207 /**
6208 * A value that specifies that the DB instance class of the DB instance uses its default processor features.
6209 */
6210 UseDefaultProcessorFeatures?: BooleanOptional;
6211 /**
6212 * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.
6213 */
6214 DeletionProtection?: BooleanOptional;
6215 }
6216 export interface RestoreDBInstanceFromS3Result {
6217 DBInstance?: DBInstance;
6218 }
6219 export interface RestoreDBInstanceToPointInTimeMessage {
6220 /**
6221 * The identifier of the source DB instance from which to restore. Constraints: Must match the identifier of an existing DB instance.
6222 */
6223 SourceDBInstanceIdentifier?: String;
6224 /**
6225 * The name of the new DB instance to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
6226 */
6227 TargetDBInstanceIdentifier: String;
6228 /**
6229 * 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 Can't be specified if UseLatestRestorableTime parameter is true Example: 2009-09-07T23:45:00Z
6230 */
6231 RestoreTime?: TStamp;
6232 /**
6233 * Specifies whether (true) or not (false) the DB instance is restored from the latest backup time. Default: false Constraints: Can't be specified if RestoreTime parameter is provided.
6234 */
6235 UseLatestRestorableTime?: Boolean;
6236 /**
6237 * The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.
6238 */
6239 DBInstanceClass?: String;
6240 /**
6241 * The port number on which the database accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB instance.
6242 */
6243 Port?: IntegerOptional;
6244 /**
6245 * The EC2 Availability Zone that the DB instance is created in. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true. Example: us-east-1a
6246 */
6247 AvailabilityZone?: String;
6248 /**
6249 * The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
6250 */
6251 DBSubnetGroupName?: String;
6252 /**
6253 * Specifies if the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
6254 */
6255 MultiAZ?: BooleanOptional;
6256 /**
6257 * 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. For more information, see CreateDBInstance.
6258 */
6259 PubliclyAccessible?: BooleanOptional;
6260 /**
6261 * Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
6262 */
6263 AutoMinorVersionUpgrade?: BooleanOptional;
6264 /**
6265 * License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
6266 */
6267 LicenseModel?: String;
6268 /**
6269 * The database name for the restored DB instance. This parameter is not used for the MySQL or MariaDB engines.
6270 */
6271 DBName?: String;
6272 /**
6273 * 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: mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
6274 */
6275 Engine?: String;
6276 /**
6277 * 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.
6278 */
6279 Iops?: IntegerOptional;
6280 /**
6281 * 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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
6282 */
6283 OptionGroupName?: String;
6284 /**
6285 * True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false.
6286 */
6287 CopyTagsToSnapshot?: BooleanOptional;
6288 Tags?: TagList;
6289 /**
6290 * 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
6291 */
6292 StorageType?: String;
6293 /**
6294 * The ARN from the key store with which to associate the instance for TDE encryption.
6295 */
6296 TdeCredentialArn?: String;
6297 /**
6298 * The password for the given ARN from the key store in order to access the device.
6299 */
6300 TdeCredentialPassword?: String;
6301 /**
6302 * 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.
6303 */
6304 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
6305 /**
6306 * Specify the Active Directory Domain to restore the instance in.
6307 */
6308 Domain?: String;
6309 /**
6310 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
6311 */
6312 DomainIAMRoleName?: String;
6313 /**
6314 * True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Default: false
6315 */
6316 EnableIAMDatabaseAuthentication?: BooleanOptional;
6317 /**
6318 * The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
6319 */
6320 EnableCloudwatchLogsExports?: LogTypeList;
6321 /**
6322 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
6323 */
6324 ProcessorFeatures?: ProcessorFeatureList;
6325 /**
6326 * A value that specifies that the DB instance class of the DB instance uses its default processor features.
6327 */
6328 UseDefaultProcessorFeatures?: BooleanOptional;
6329 /**
6330 * 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 is used. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
6331 */
6332 DBParameterGroupName?: String;
6333 /**
6334 * Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.
6335 */
6336 DeletionProtection?: BooleanOptional;
6337 /**
6338 * The resource ID of the source DB instance from which to restore.
6339 */
6340 SourceDbiResourceId?: String;
6341 }
6342 export interface RestoreDBInstanceToPointInTimeResult {
6343 DBInstance?: DBInstance;
6344 }
6345 export interface RestoreWindow {
6346 /**
6347 * The earliest time you can restore an instance to.
6348 */
6349 EarliestTime?: TStamp;
6350 /**
6351 * The latest time you can restore an instance to.
6352 */
6353 LatestTime?: TStamp;
6354 }
6355 export interface RevokeDBSecurityGroupIngressMessage {
6356 /**
6357 * The name of the DB security group to revoke ingress from.
6358 */
6359 DBSecurityGroupName: String;
6360 /**
6361 * The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.
6362 */
6363 CIDRIP?: String;
6364 /**
6365 * 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.
6366 */
6367 EC2SecurityGroupName?: String;
6368 /**
6369 * 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.
6370 */
6371 EC2SecurityGroupId?: String;
6372 /**
6373 * 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.
6374 */
6375 EC2SecurityGroupOwnerId?: String;
6376 }
6377 export interface RevokeDBSecurityGroupIngressResult {
6378 DBSecurityGroup?: DBSecurityGroup;
6379 }
6380 export interface ScalingConfiguration {
6381 /**
6382 * The minimum capacity for an Aurora DB cluster in serverless DB engine mode. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256. The minimum capacity must be less than or equal to the maximum capacity.
6383 */
6384 MinCapacity?: IntegerOptional;
6385 /**
6386 * The maximum capacity for an Aurora DB cluster in serverless DB engine mode. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256. The maximum capacity must be greater than or equal to the minimum capacity.
6387 */
6388 MaxCapacity?: IntegerOptional;
6389 /**
6390 * A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
6391 */
6392 AutoPause?: BooleanOptional;
6393 /**
6394 * The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
6395 */
6396 SecondsUntilAutoPause?: IntegerOptional;
6397 }
6398 export interface ScalingConfigurationInfo {
6399 /**
6400 * The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
6401 */
6402 MinCapacity?: IntegerOptional;
6403 /**
6404 * The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
6405 */
6406 MaxCapacity?: IntegerOptional;
6407 /**
6408 * A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
6409 */
6410 AutoPause?: BooleanOptional;
6411 /**
6412 * The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
6413 */
6414 SecondsUntilAutoPause?: IntegerOptional;
6415 }
6416 export type SourceIdsList = String[];
6417 export interface SourceRegion {
6418 /**
6419 * The name of the source AWS Region.
6420 */
6421 RegionName?: String;
6422 /**
6423 * The endpoint for the source AWS Region endpoint.
6424 */
6425 Endpoint?: String;
6426 /**
6427 * The status of the source AWS Region.
6428 */
6429 Status?: String;
6430 }
6431 export type SourceRegionList = SourceRegion[];
6432 export interface SourceRegionMessage {
6433 /**
6434 * 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.
6435 */
6436 Marker?: String;
6437 /**
6438 * A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.
6439 */
6440 SourceRegions?: SourceRegionList;
6441 }
6442 export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
6443 export interface StartDBClusterMessage {
6444 /**
6445 * The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
6446 */
6447 DBClusterIdentifier: String;
6448 }
6449 export interface StartDBClusterResult {
6450 DBCluster?: DBCluster;
6451 }
6452 export interface StartDBInstanceMessage {
6453 /**
6454 * The user-supplied instance identifier.
6455 */
6456 DBInstanceIdentifier: String;
6457 }
6458 export interface StartDBInstanceResult {
6459 DBInstance?: DBInstance;
6460 }
6461 export interface StopDBClusterMessage {
6462 /**
6463 * The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
6464 */
6465 DBClusterIdentifier: String;
6466 }
6467 export interface StopDBClusterResult {
6468 DBCluster?: DBCluster;
6469 }
6470 export interface StopDBInstanceMessage {
6471 /**
6472 * The user-supplied instance identifier.
6473 */
6474 DBInstanceIdentifier: String;
6475 /**
6476 * The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
6477 */
6478 DBSnapshotIdentifier?: String;
6479 }
6480 export interface StopDBInstanceResult {
6481 DBInstance?: DBInstance;
6482 }
6483 export type String = string;
6484 export type StringList = String[];
6485 export interface Subnet {
6486 /**
6487 * Specifies the identifier of the subnet.
6488 */
6489 SubnetIdentifier?: String;
6490 SubnetAvailabilityZone?: AvailabilityZone;
6491 /**
6492 * Specifies the status of the subnet.
6493 */
6494 SubnetStatus?: String;
6495 }
6496 export type SubnetIdentifierList = String[];
6497 export type SubnetList = Subnet[];
6498 export type SupportedCharacterSetsList = CharacterSet[];
6499 export type SupportedTimezonesList = Timezone[];
6500 export type TStamp = Date;
6501 export interface Tag {
6502 /**
6503 * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
6504 */
6505 Key?: String;
6506 /**
6507 * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
6508 */
6509 Value?: String;
6510 }
6511 export type TagList = Tag[];
6512 export interface TagListMessage {
6513 /**
6514 * List of tags returned by the ListTagsForResource operation.
6515 */
6516 TagList?: TagList;
6517 }
6518 export interface Timezone {
6519 /**
6520 * The name of the time zone.
6521 */
6522 TimezoneName?: String;
6523 }
6524 export interface UpgradeTarget {
6525 /**
6526 * The name of the upgrade target database engine.
6527 */
6528 Engine?: String;
6529 /**
6530 * The version number of the upgrade target database engine.
6531 */
6532 EngineVersion?: String;
6533 /**
6534 * The version of the database engine that a DB instance can be upgraded to.
6535 */
6536 Description?: String;
6537 /**
6538 * A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
6539 */
6540 AutoUpgrade?: Boolean;
6541 /**
6542 * A value that indicates whether a database engine is upgraded to a major version.
6543 */
6544 IsMajorVersionUpgrade?: Boolean;
6545 }
6546 export interface ValidDBInstanceModificationsMessage {
6547 /**
6548 * Valid storage options for your DB instance.
6549 */
6550 Storage?: ValidStorageOptionsList;
6551 /**
6552 * Valid processor features for your DB instance.
6553 */
6554 ValidProcessorFeatures?: AvailableProcessorFeatureList;
6555 }
6556 export interface ValidStorageOptions {
6557 /**
6558 * The valid storage types for your DB instance. For example, gp2, io1.
6559 */
6560 StorageType?: String;
6561 /**
6562 * The valid range of storage in gibibytes. For example, 100 to 16384.
6563 */
6564 StorageSize?: RangeList;
6565 /**
6566 * The valid range of provisioned IOPS. For example, 1000-20000.
6567 */
6568 ProvisionedIops?: RangeList;
6569 /**
6570 * The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
6571 */
6572 IopsToStorageRatio?: DoubleRangeList;
6573 }
6574 export type ValidStorageOptionsList = ValidStorageOptions[];
6575 export type ValidUpgradeTargetList = UpgradeTarget[];
6576 export type VpcSecurityGroupIdList = String[];
6577 export interface VpcSecurityGroupMembership {
6578 /**
6579 * The name of the VPC security group.
6580 */
6581 VpcSecurityGroupId?: String;
6582 /**
6583 * The status of the VPC security group.
6584 */
6585 Status?: String;
6586 }
6587 export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
6588 /**
6589 * 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.
6590 */
6591 export type apiVersion = "2013-01-10"|"2013-02-12"|"2013-09-09"|"2014-09-01"|"2014-09-01"|"2014-10-31"|"latest"|string;
6592 export interface ClientApiVersions {
6593 /**
6594 * 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.
6595 */
6596 apiVersion?: apiVersion;
6597 }
6598 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
6599 /**
6600 * Contains interfaces for use with the RDS client.
6601 */
6602 export import Types = RDS;
6603}
6604export = RDS;