UNPKG

524 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. To add a role to a DB instance, the status of the DB instance must be available.
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. To add a role to a DB instance, the status of the DB instance must be available.
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 * Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
74 */
75 cancelExportTask(params: RDS.Types.CancelExportTaskMessage, callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
76 /**
77 * Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
78 */
79 cancelExportTask(callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
80 /**
81 * Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters.
82 */
83 copyDBClusterParameterGroup(params: RDS.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
84 /**
85 * Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters.
86 */
87 copyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
88 /**
89 * 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 is to 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 are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. 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.
90 */
91 copyDBClusterSnapshot(params: RDS.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
92 /**
93 * 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 is to 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 are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. 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.
94 */
95 copyDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
96 /**
97 * Copies the specified DB parameter group.
98 */
99 copyDBParameterGroup(params: RDS.Types.CopyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
100 /**
101 * Copies the specified DB parameter group.
102 */
103 copyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
104 /**
105 * 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.
106 */
107 copyDBSnapshot(params: RDS.Types.CopyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
108 /**
109 * 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.
110 */
111 copyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
112 /**
113 * Copies the specified option group.
114 */
115 copyOptionGroup(params: RDS.Types.CopyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request<RDS.Types.CopyOptionGroupResult, AWSError>;
116 /**
117 * Copies the specified option group.
118 */
119 copyOptionGroup(callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request<RDS.Types.CopyOptionGroupResult, AWSError>;
120 /**
121 * Creates a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
122 */
123 createCustomAvailabilityZone(params: RDS.Types.CreateCustomAvailabilityZoneMessage, callback?: (err: AWSError, data: RDS.Types.CreateCustomAvailabilityZoneResult) => void): Request<RDS.Types.CreateCustomAvailabilityZoneResult, AWSError>;
124 /**
125 * Creates a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
126 */
127 createCustomAvailabilityZone(callback?: (err: AWSError, data: RDS.Types.CreateCustomAvailabilityZoneResult) => void): Request<RDS.Types.CreateCustomAvailabilityZoneResult, AWSError>;
128 /**
129 * 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.
130 */
131 createDBCluster(params: RDS.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
132 /**
133 * 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.
134 */
135 createDBCluster(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
136 /**
137 * Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
138 */
139 createDBClusterEndpoint(params: RDS.Types.CreateDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
140 /**
141 * Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
142 */
143 createDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
144 /**
145 * 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 action 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.
146 */
147 createDBClusterParameterGroup(params: RDS.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
148 /**
149 * 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 action 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.
150 */
151 createDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
152 /**
153 * 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.
154 */
155 createDBClusterSnapshot(params: RDS.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
156 /**
157 * 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.
158 */
159 createDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
160 /**
161 * Creates a new DB instance.
162 */
163 createDBInstance(params: RDS.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
164 /**
165 * Creates a new DB instance.
166 */
167 createDBInstance(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
168 /**
169 * 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, Oracle, or PostgreSQL. For more information, see Working with 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.
170 */
171 createDBInstanceReadReplica(params: RDS.Types.CreateDBInstanceReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
172 /**
173 * 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, Oracle, or PostgreSQL. For more information, see Working with 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.
174 */
175 createDBInstanceReadReplica(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
176 /**
177 * 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.
178 */
179 createDBParameterGroup(params: RDS.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
180 /**
181 * 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.
182 */
183 createDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
184 /**
185 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Creates a new DB proxy.
186 */
187 createDBProxy(params: RDS.Types.CreateDBProxyRequest, callback?: (err: AWSError, data: RDS.Types.CreateDBProxyResponse) => void): Request<RDS.Types.CreateDBProxyResponse, AWSError>;
188 /**
189 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Creates a new DB proxy.
190 */
191 createDBProxy(callback?: (err: AWSError, data: RDS.Types.CreateDBProxyResponse) => void): Request<RDS.Types.CreateDBProxyResponse, AWSError>;
192 /**
193 * 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.
194 */
195 createDBSecurityGroup(params: RDS.Types.CreateDBSecurityGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
196 /**
197 * 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.
198 */
199 createDBSecurityGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
200 /**
201 * Creates a DBSnapshot. The source DBInstance must be in "available" state.
202 */
203 createDBSnapshot(params: RDS.Types.CreateDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
204 /**
205 * Creates a DBSnapshot. The source DBInstance must be in "available" state.
206 */
207 createDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
208 /**
209 * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
210 */
211 createDBSubnetGroup(params: RDS.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
212 /**
213 * Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
214 */
215 createDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
216 /**
217 * Creates an RDS event notification subscription. This action requires a topic Amazon Resource Name (ARN) 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 don't specify either the SourceType or the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account. RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
218 */
219 createEventSubscription(params: RDS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
220 /**
221 * Creates an RDS event notification subscription. This action requires a topic Amazon Resource Name (ARN) 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 don't specify either the SourceType or the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account. RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
222 */
223 createEventSubscription(callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
224 /**
225 * 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.
226 */
227 createGlobalCluster(params: RDS.Types.CreateGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
228 /**
229 * 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.
230 */
231 createGlobalCluster(callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
232 /**
233 * Creates a new option group. You can create up to 20 option groups.
234 */
235 createOptionGroup(params: RDS.Types.CreateOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
236 /**
237 * Creates a new option group. You can create up to 20 option groups.
238 */
239 createOptionGroup(callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
240 /**
241 * Deletes a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
242 */
243 deleteCustomAvailabilityZone(params: RDS.Types.DeleteCustomAvailabilityZoneMessage, callback?: (err: AWSError, data: RDS.Types.DeleteCustomAvailabilityZoneResult) => void): Request<RDS.Types.DeleteCustomAvailabilityZoneResult, AWSError>;
244 /**
245 * Deletes a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
246 */
247 deleteCustomAvailabilityZone(callback?: (err: AWSError, data: RDS.Types.DeleteCustomAvailabilityZoneResult) => void): Request<RDS.Types.DeleteCustomAvailabilityZoneResult, AWSError>;
248 /**
249 * 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.
250 */
251 deleteDBCluster(params: RDS.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
252 /**
253 * 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.
254 */
255 deleteDBCluster(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
256 /**
257 * Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
258 */
259 deleteDBClusterEndpoint(params: RDS.Types.DeleteDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
260 /**
261 * Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
262 */
263 deleteDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
264 /**
265 * 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.
266 */
267 deleteDBClusterParameterGroup(params: RDS.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
268 /**
269 * 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.
270 */
271 deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
272 /**
273 * 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.
274 */
275 deleteDBClusterSnapshot(params: RDS.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
276 /**
277 * 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.
278 */
279 deleteDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
280 /**
281 * 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. 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 you skip creation of the final snapshot with the SkipFinalSnapshot parameter. 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.
282 */
283 deleteDBInstance(params: RDS.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
284 /**
285 * 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. 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 you skip creation of the final snapshot with the SkipFinalSnapshot parameter. 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.
286 */
287 deleteDBInstance(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
288 /**
289 * Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.
290 */
291 deleteDBInstanceAutomatedBackup(params: RDS.Types.DeleteDBInstanceAutomatedBackupMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request<RDS.Types.DeleteDBInstanceAutomatedBackupResult, AWSError>;
292 /**
293 * Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.
294 */
295 deleteDBInstanceAutomatedBackup(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request<RDS.Types.DeleteDBInstanceAutomatedBackupResult, AWSError>;
296 /**
297 * Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
298 */
299 deleteDBParameterGroup(params: RDS.Types.DeleteDBParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
300 /**
301 * Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
302 */
303 deleteDBParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
304 /**
305 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Deletes an existing proxy.
306 */
307 deleteDBProxy(params: RDS.Types.DeleteDBProxyRequest, callback?: (err: AWSError, data: RDS.Types.DeleteDBProxyResponse) => void): Request<RDS.Types.DeleteDBProxyResponse, AWSError>;
308 /**
309 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Deletes an existing proxy.
310 */
311 deleteDBProxy(callback?: (err: AWSError, data: RDS.Types.DeleteDBProxyResponse) => void): Request<RDS.Types.DeleteDBProxyResponse, AWSError>;
312 /**
313 * Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
314 */
315 deleteDBSecurityGroup(params: RDS.Types.DeleteDBSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
316 /**
317 * Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
318 */
319 deleteDBSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
320 /**
321 * 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.
322 */
323 deleteDBSnapshot(params: RDS.Types.DeleteDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request<RDS.Types.DeleteDBSnapshotResult, AWSError>;
324 /**
325 * 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.
326 */
327 deleteDBSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request<RDS.Types.DeleteDBSnapshotResult, AWSError>;
328 /**
329 * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
330 */
331 deleteDBSubnetGroup(params: RDS.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
332 /**
333 * Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
334 */
335 deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
336 /**
337 * Deletes an RDS event notification subscription.
338 */
339 deleteEventSubscription(params: RDS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request<RDS.Types.DeleteEventSubscriptionResult, AWSError>;
340 /**
341 * Deletes an RDS event notification subscription.
342 */
343 deleteEventSubscription(callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request<RDS.Types.DeleteEventSubscriptionResult, AWSError>;
344 /**
345 * 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.
346 */
347 deleteGlobalCluster(params: RDS.Types.DeleteGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteGlobalClusterResult) => void): Request<RDS.Types.DeleteGlobalClusterResult, AWSError>;
348 /**
349 * 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.
350 */
351 deleteGlobalCluster(callback?: (err: AWSError, data: RDS.Types.DeleteGlobalClusterResult) => void): Request<RDS.Types.DeleteGlobalClusterResult, AWSError>;
352 /**
353 * Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
354 */
355 deleteInstallationMedia(params: RDS.Types.DeleteInstallationMediaMessage, callback?: (err: AWSError, data: RDS.Types.InstallationMedia) => void): Request<RDS.Types.InstallationMedia, AWSError>;
356 /**
357 * Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
358 */
359 deleteInstallationMedia(callback?: (err: AWSError, data: RDS.Types.InstallationMedia) => void): Request<RDS.Types.InstallationMedia, AWSError>;
360 /**
361 * Deletes an existing option group.
362 */
363 deleteOptionGroup(params: RDS.Types.DeleteOptionGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
364 /**
365 * Deletes an existing option group.
366 */
367 deleteOptionGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
368 /**
369 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
370 */
371 deregisterDBProxyTargets(params: RDS.Types.DeregisterDBProxyTargetsRequest, callback?: (err: AWSError, data: RDS.Types.DeregisterDBProxyTargetsResponse) => void): Request<RDS.Types.DeregisterDBProxyTargetsResponse, AWSError>;
372 /**
373 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
374 */
375 deregisterDBProxyTargets(callback?: (err: AWSError, data: RDS.Types.DeregisterDBProxyTargetsResponse) => void): Request<RDS.Types.DeregisterDBProxyTargetsResponse, AWSError>;
376 /**
377 * 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.
378 */
379 describeAccountAttributes(params: RDS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request<RDS.Types.AccountAttributesMessage, AWSError>;
380 /**
381 * 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.
382 */
383 describeAccountAttributes(callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request<RDS.Types.AccountAttributesMessage, AWSError>;
384 /**
385 * Lists the set of CA certificates provided by Amazon RDS for this AWS account.
386 */
387 describeCertificates(params: RDS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request<RDS.Types.CertificateMessage, AWSError>;
388 /**
389 * Lists the set of CA certificates provided by Amazon RDS for this AWS account.
390 */
391 describeCertificates(callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request<RDS.Types.CertificateMessage, AWSError>;
392 /**
393 * Returns information about custom Availability Zones (AZs). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
394 */
395 describeCustomAvailabilityZones(params: RDS.Types.DescribeCustomAvailabilityZonesMessage, callback?: (err: AWSError, data: RDS.Types.CustomAvailabilityZoneMessage) => void): Request<RDS.Types.CustomAvailabilityZoneMessage, AWSError>;
396 /**
397 * Returns information about custom Availability Zones (AZs). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
398 */
399 describeCustomAvailabilityZones(callback?: (err: AWSError, data: RDS.Types.CustomAvailabilityZoneMessage) => void): Request<RDS.Types.CustomAvailabilityZoneMessage, AWSError>;
400 /**
401 * 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.
402 */
403 describeDBClusterBacktracks(params: RDS.Types.DescribeDBClusterBacktracksMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request<RDS.Types.DBClusterBacktrackMessage, AWSError>;
404 /**
405 * 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.
406 */
407 describeDBClusterBacktracks(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request<RDS.Types.DBClusterBacktrackMessage, AWSError>;
408 /**
409 * Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
410 */
411 describeDBClusterEndpoints(params: RDS.Types.DescribeDBClusterEndpointsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request<RDS.Types.DBClusterEndpointMessage, AWSError>;
412 /**
413 * Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
414 */
415 describeDBClusterEndpoints(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request<RDS.Types.DBClusterEndpointMessage, AWSError>;
416 /**
417 * 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.
418 */
419 describeDBClusterParameterGroups(params: RDS.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
420 /**
421 * 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.
422 */
423 describeDBClusterParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
424 /**
425 * 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.
426 */
427 describeDBClusterParameters(params: RDS.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
428 /**
429 * 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.
430 */
431 describeDBClusterParameters(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
432 /**
433 * 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.
434 */
435 describeDBClusterSnapshotAttributes(params: RDS.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
436 /**
437 * 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.
438 */
439 describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
440 /**
441 * 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.
442 */
443 describeDBClusterSnapshots(params: RDS.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
444 /**
445 * 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.
446 */
447 describeDBClusterSnapshots(callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
448 /**
449 * 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 operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
450 */
451 describeDBClusters(params: RDS.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
452 /**
453 * 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 operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
454 */
455 describeDBClusters(callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
456 /**
457 * Returns a list of the available DB engines.
458 */
459 describeDBEngineVersions(params: RDS.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request<RDS.Types.DBEngineVersionMessage, AWSError>;
460 /**
461 * Returns a list of the available DB engines.
462 */
463 describeDBEngineVersions(callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request<RDS.Types.DBEngineVersionMessage, AWSError>;
464 /**
465 * 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.
466 */
467 describeDBInstanceAutomatedBackups(params: RDS.Types.DescribeDBInstanceAutomatedBackupsMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request<RDS.Types.DBInstanceAutomatedBackupMessage, AWSError>;
468 /**
469 * 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.
470 */
471 describeDBInstanceAutomatedBackups(callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request<RDS.Types.DBInstanceAutomatedBackupMessage, AWSError>;
472 /**
473 * Returns information about provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
474 */
475 describeDBInstances(params: RDS.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
476 /**
477 * Returns information about provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
478 */
479 describeDBInstances(callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
480 /**
481 * Returns a list of DB log files for the DB instance.
482 */
483 describeDBLogFiles(params: RDS.Types.DescribeDBLogFilesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
484 /**
485 * Returns a list of DB log files for the DB instance.
486 */
487 describeDBLogFiles(callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
488 /**
489 * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
490 */
491 describeDBParameterGroups(params: RDS.Types.DescribeDBParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request<RDS.Types.DBParameterGroupsMessage, AWSError>;
492 /**
493 * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
494 */
495 describeDBParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request<RDS.Types.DBParameterGroupsMessage, AWSError>;
496 /**
497 * Returns the detailed parameter list for a particular DB parameter group.
498 */
499 describeDBParameters(params: RDS.Types.DescribeDBParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request<RDS.Types.DBParameterGroupDetails, AWSError>;
500 /**
501 * Returns the detailed parameter list for a particular DB parameter group.
502 */
503 describeDBParameters(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request<RDS.Types.DBParameterGroupDetails, AWSError>;
504 /**
505 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Returns information about DB proxies.
506 */
507 describeDBProxies(params: RDS.Types.DescribeDBProxiesRequest, callback?: (err: AWSError, data: RDS.Types.DescribeDBProxiesResponse) => void): Request<RDS.Types.DescribeDBProxiesResponse, AWSError>;
508 /**
509 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Returns information about DB proxies.
510 */
511 describeDBProxies(callback?: (err: AWSError, data: RDS.Types.DescribeDBProxiesResponse) => void): Request<RDS.Types.DescribeDBProxiesResponse, AWSError>;
512 /**
513 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
514 */
515 describeDBProxyTargetGroups(params: RDS.Types.DescribeDBProxyTargetGroupsRequest, callback?: (err: AWSError, data: RDS.Types.DescribeDBProxyTargetGroupsResponse) => void): Request<RDS.Types.DescribeDBProxyTargetGroupsResponse, AWSError>;
516 /**
517 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
518 */
519 describeDBProxyTargetGroups(callback?: (err: AWSError, data: RDS.Types.DescribeDBProxyTargetGroupsResponse) => void): Request<RDS.Types.DescribeDBProxyTargetGroupsResponse, AWSError>;
520 /**
521 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Returns information about DBProxyTarget objects. This API supports pagination.
522 */
523 describeDBProxyTargets(params: RDS.Types.DescribeDBProxyTargetsRequest, callback?: (err: AWSError, data: RDS.Types.DescribeDBProxyTargetsResponse) => void): Request<RDS.Types.DescribeDBProxyTargetsResponse, AWSError>;
524 /**
525 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Returns information about DBProxyTarget objects. This API supports pagination.
526 */
527 describeDBProxyTargets(callback?: (err: AWSError, data: RDS.Types.DescribeDBProxyTargetsResponse) => void): Request<RDS.Types.DescribeDBProxyTargetsResponse, AWSError>;
528 /**
529 * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
530 */
531 describeDBSecurityGroups(params: RDS.Types.DescribeDBSecurityGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request<RDS.Types.DBSecurityGroupMessage, AWSError>;
532 /**
533 * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
534 */
535 describeDBSecurityGroups(callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request<RDS.Types.DBSecurityGroupMessage, AWSError>;
536 /**
537 * 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.
538 */
539 describeDBSnapshotAttributes(params: RDS.Types.DescribeDBSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBSnapshotAttributesResult, AWSError>;
540 /**
541 * 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.
542 */
543 describeDBSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBSnapshotAttributesResult, AWSError>;
544 /**
545 * Returns information about DB snapshots. This API action supports pagination.
546 */
547 describeDBSnapshots(params: RDS.Types.DescribeDBSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
548 /**
549 * Returns information about DB snapshots. This API action supports pagination.
550 */
551 describeDBSnapshots(callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
552 /**
553 * 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.
554 */
555 describeDBSubnetGroups(params: RDS.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
556 /**
557 * 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.
558 */
559 describeDBSubnetGroups(callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
560 /**
561 * 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.
562 */
563 describeEngineDefaultClusterParameters(params: RDS.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
564 /**
565 * 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.
566 */
567 describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
568 /**
569 * Returns the default engine and system parameter information for the specified database engine.
570 */
571 describeEngineDefaultParameters(params: RDS.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultParametersResult, AWSError>;
572 /**
573 * Returns the default engine and system parameter information for the specified database engine.
574 */
575 describeEngineDefaultParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultParametersResult, AWSError>;
576 /**
577 * 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.
578 */
579 describeEventCategories(params: RDS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request<RDS.Types.EventCategoriesMessage, AWSError>;
580 /**
581 * 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.
582 */
583 describeEventCategories(callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request<RDS.Types.EventCategoriesMessage, AWSError>;
584 /**
585 * 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.
586 */
587 describeEventSubscriptions(params: RDS.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
588 /**
589 * 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.
590 */
591 describeEventSubscriptions(callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
592 /**
593 * 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.
594 */
595 describeEvents(params: RDS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
596 /**
597 * 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.
598 */
599 describeEvents(callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
600 /**
601 * Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
602 */
603 describeExportTasks(params: RDS.Types.DescribeExportTasksMessage, callback?: (err: AWSError, data: RDS.Types.ExportTasksMessage) => void): Request<RDS.Types.ExportTasksMessage, AWSError>;
604 /**
605 * Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
606 */
607 describeExportTasks(callback?: (err: AWSError, data: RDS.Types.ExportTasksMessage) => void): Request<RDS.Types.ExportTasksMessage, AWSError>;
608 /**
609 * 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.
610 */
611 describeGlobalClusters(params: RDS.Types.DescribeGlobalClustersMessage, callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request<RDS.Types.GlobalClustersMessage, AWSError>;
612 /**
613 * 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.
614 */
615 describeGlobalClusters(callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request<RDS.Types.GlobalClustersMessage, AWSError>;
616 /**
617 * Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
618 */
619 describeInstallationMedia(params: RDS.Types.DescribeInstallationMediaMessage, callback?: (err: AWSError, data: RDS.Types.InstallationMediaMessage) => void): Request<RDS.Types.InstallationMediaMessage, AWSError>;
620 /**
621 * Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
622 */
623 describeInstallationMedia(callback?: (err: AWSError, data: RDS.Types.InstallationMediaMessage) => void): Request<RDS.Types.InstallationMediaMessage, AWSError>;
624 /**
625 * Describes all available options.
626 */
627 describeOptionGroupOptions(params: RDS.Types.DescribeOptionGroupOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request<RDS.Types.OptionGroupOptionsMessage, AWSError>;
628 /**
629 * Describes all available options.
630 */
631 describeOptionGroupOptions(callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request<RDS.Types.OptionGroupOptionsMessage, AWSError>;
632 /**
633 * Describes the available option groups.
634 */
635 describeOptionGroups(params: RDS.Types.DescribeOptionGroupsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
636 /**
637 * Describes the available option groups.
638 */
639 describeOptionGroups(callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
640 /**
641 * Returns a list of orderable DB instance options for the specified engine.
642 */
643 describeOrderableDBInstanceOptions(params: RDS.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
644 /**
645 * Returns a list of orderable DB instance options for the specified engine.
646 */
647 describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
648 /**
649 * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
650 */
651 describePendingMaintenanceActions(params: RDS.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request<RDS.Types.PendingMaintenanceActionsMessage, AWSError>;
652 /**
653 * Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
654 */
655 describePendingMaintenanceActions(callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request<RDS.Types.PendingMaintenanceActionsMessage, AWSError>;
656 /**
657 * Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
658 */
659 describeReservedDBInstances(params: RDS.Types.DescribeReservedDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request<RDS.Types.ReservedDBInstanceMessage, AWSError>;
660 /**
661 * Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
662 */
663 describeReservedDBInstances(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request<RDS.Types.ReservedDBInstanceMessage, AWSError>;
664 /**
665 * Lists available reserved DB instance offerings.
666 */
667 describeReservedDBInstancesOfferings(params: RDS.Types.DescribeReservedDBInstancesOfferingsMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request<RDS.Types.ReservedDBInstancesOfferingMessage, AWSError>;
668 /**
669 * Lists available reserved DB instance offerings.
670 */
671 describeReservedDBInstancesOfferings(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request<RDS.Types.ReservedDBInstancesOfferingMessage, AWSError>;
672 /**
673 * 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.
674 */
675 describeSourceRegions(params: RDS.Types.DescribeSourceRegionsMessage, callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
676 /**
677 * 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.
678 */
679 describeSourceRegions(callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
680 /**
681 * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
682 */
683 describeValidDBInstanceModifications(params: RDS.Types.DescribeValidDBInstanceModificationsMessage, callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
684 /**
685 * You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
686 */
687 describeValidDBInstanceModifications(callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
688 /**
689 * Downloads all or a portion of the specified log file, up to 1 MB in size.
690 */
691 downloadDBLogFilePortion(params: RDS.Types.DownloadDBLogFilePortionMessage, callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
692 /**
693 * Downloads all or a portion of the specified log file, up to 1 MB in size.
694 */
695 downloadDBLogFilePortion(callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
696 /**
697 * 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.
698 */
699 failoverDBCluster(params: RDS.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
700 /**
701 * 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.
702 */
703 failoverDBCluster(callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
704 /**
705 * Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.
706 */
707 importInstallationMedia(params: RDS.Types.ImportInstallationMediaMessage, callback?: (err: AWSError, data: RDS.Types.InstallationMedia) => void): Request<RDS.Types.InstallationMedia, AWSError>;
708 /**
709 * Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.
710 */
711 importInstallationMedia(callback?: (err: AWSError, data: RDS.Types.InstallationMedia) => void): Request<RDS.Types.InstallationMedia, AWSError>;
712 /**
713 * 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.
714 */
715 listTagsForResource(params: RDS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request<RDS.Types.TagListMessage, AWSError>;
716 /**
717 * 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.
718 */
719 listTagsForResource(callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request<RDS.Types.TagListMessage, AWSError>;
720 /**
721 * Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances temporarily, or remove the override. By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS. You might need to override the default certificate in the following situations: You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified AWS Region. RDS has already moved to a new default CA certificate for the specified AWS Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes. For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
722 */
723 modifyCertificates(params: RDS.Types.ModifyCertificatesMessage, callback?: (err: AWSError, data: RDS.Types.ModifyCertificatesResult) => void): Request<RDS.Types.ModifyCertificatesResult, AWSError>;
724 /**
725 * Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances temporarily, or remove the override. By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS. You might need to override the default certificate in the following situations: You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified AWS Region. RDS has already moved to a new default CA certificate for the specified AWS Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes. For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
726 */
727 modifyCertificates(callback?: (err: AWSError, data: RDS.Types.ModifyCertificatesResult) => void): Request<RDS.Types.ModifyCertificatesResult, AWSError>;
728 /**
729 * 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.
730 */
731 modifyCurrentDBClusterCapacity(params: RDS.Types.ModifyCurrentDBClusterCapacityMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
732 /**
733 * 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.
734 */
735 modifyCurrentDBClusterCapacity(callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
736 /**
737 * 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.
738 */
739 modifyDBCluster(params: RDS.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
740 /**
741 * 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.
742 */
743 modifyDBCluster(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
744 /**
745 * Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
746 */
747 modifyDBClusterEndpoint(params: RDS.Types.ModifyDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
748 /**
749 * Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
750 */
751 modifyDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
752 /**
753 * 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 action to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. This action only applies to Aurora DB clusters.
754 */
755 modifyDBClusterParameterGroup(params: RDS.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
756 /**
757 * 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 action to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. This action only applies to Aurora DB clusters.
758 */
759 modifyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
760 /**
761 * 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.
762 */
763 modifyDBClusterSnapshotAttribute(params: RDS.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
764 /**
765 * 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.
766 */
767 modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
768 /**
769 * 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.
770 */
771 modifyDBInstance(params: RDS.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request<RDS.Types.ModifyDBInstanceResult, AWSError>;
772 /**
773 * 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.
774 */
775 modifyDBInstance(callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request<RDS.Types.ModifyDBInstanceResult, AWSError>;
776 /**
777 * 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.
778 */
779 modifyDBParameterGroup(params: RDS.Types.ModifyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
780 /**
781 * 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.
782 */
783 modifyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
784 /**
785 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Changes the settings for an existing DB proxy.
786 */
787 modifyDBProxy(params: RDS.Types.ModifyDBProxyRequest, callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyResponse) => void): Request<RDS.Types.ModifyDBProxyResponse, AWSError>;
788 /**
789 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Changes the settings for an existing DB proxy.
790 */
791 modifyDBProxy(callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyResponse) => void): Request<RDS.Types.ModifyDBProxyResponse, AWSError>;
792 /**
793 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Modifies the properties of a DBProxyTargetGroup.
794 */
795 modifyDBProxyTargetGroup(params: RDS.Types.ModifyDBProxyTargetGroupRequest, callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyTargetGroupResponse) => void): Request<RDS.Types.ModifyDBProxyTargetGroupResponse, AWSError>;
796 /**
797 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Modifies the properties of a DBProxyTargetGroup.
798 */
799 modifyDBProxyTargetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyTargetGroupResponse) => void): Request<RDS.Types.ModifyDBProxyTargetGroupResponse, AWSError>;
800 /**
801 * 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, Oracle, and PostgreSQL.
802 */
803 modifyDBSnapshot(params: RDS.Types.ModifyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
804 /**
805 * 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, Oracle, and PostgreSQL.
806 */
807 modifyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
808 /**
809 * 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.
810 */
811 modifyDBSnapshotAttribute(params: RDS.Types.ModifyDBSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
812 /**
813 * 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.
814 */
815 modifyDBSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
816 /**
817 * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
818 */
819 modifyDBSubnetGroup(params: RDS.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request<RDS.Types.ModifyDBSubnetGroupResult, AWSError>;
820 /**
821 * Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
822 */
823 modifyDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request<RDS.Types.ModifyDBSubnetGroupResult, AWSError>;
824 /**
825 * Modifies an existing RDS event notification subscription. 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.
826 */
827 modifyEventSubscription(params: RDS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
828 /**
829 * Modifies an existing RDS event notification subscription. 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.
830 */
831 modifyEventSubscription(callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
832 /**
833 * 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.
834 */
835 modifyGlobalCluster(params: RDS.Types.ModifyGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request<RDS.Types.ModifyGlobalClusterResult, AWSError>;
836 /**
837 * 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.
838 */
839 modifyGlobalCluster(callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request<RDS.Types.ModifyGlobalClusterResult, AWSError>;
840 /**
841 * Modifies an existing option group.
842 */
843 modifyOptionGroup(params: RDS.Types.ModifyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
844 /**
845 * Modifies an existing option group.
846 */
847 modifyOptionGroup(callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
848 /**
849 * 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.
850 */
851 promoteReadReplica(params: RDS.Types.PromoteReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
852 /**
853 * 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.
854 */
855 promoteReadReplica(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
856 /**
857 * Promotes a Read Replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters.
858 */
859 promoteReadReplicaDBCluster(params: RDS.Types.PromoteReadReplicaDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
860 /**
861 * Promotes a Read Replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters.
862 */
863 promoteReadReplicaDBCluster(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
864 /**
865 * Purchases a reserved DB instance offering.
866 */
867 purchaseReservedDBInstancesOffering(params: RDS.Types.PurchaseReservedDBInstancesOfferingMessage, callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
868 /**
869 * Purchases a reserved DB instance offering.
870 */
871 purchaseReservedDBInstancesOffering(callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
872 /**
873 * 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.
874 */
875 rebootDBInstance(params: RDS.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
876 /**
877 * 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.
878 */
879 rebootDBInstance(callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
880 /**
881 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
882 */
883 registerDBProxyTargets(params: RDS.Types.RegisterDBProxyTargetsRequest, callback?: (err: AWSError, data: RDS.Types.RegisterDBProxyTargetsResponse) => void): Request<RDS.Types.RegisterDBProxyTargetsResponse, AWSError>;
884 /**
885 * This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change. Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
886 */
887 registerDBProxyTargets(callback?: (err: AWSError, data: RDS.Types.RegisterDBProxyTargetsResponse) => void): Request<RDS.Types.RegisterDBProxyTargetsResponse, AWSError>;
888 /**
889 * 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.
890 */
891 removeFromGlobalCluster(params: RDS.Types.RemoveFromGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request<RDS.Types.RemoveFromGlobalClusterResult, AWSError>;
892 /**
893 * 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.
894 */
895 removeFromGlobalCluster(callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request<RDS.Types.RemoveFromGlobalClusterResult, AWSError>;
896 /**
897 * 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.
898 */
899 removeRoleFromDBCluster(params: RDS.Types.RemoveRoleFromDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
900 /**
901 * 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.
902 */
903 removeRoleFromDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
904 /**
905 * Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
906 */
907 removeRoleFromDBInstance(params: RDS.Types.RemoveRoleFromDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
908 /**
909 * Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
910 */
911 removeRoleFromDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
912 /**
913 * Removes a source identifier from an existing RDS event notification subscription.
914 */
915 removeSourceIdentifierFromSubscription(params: RDS.Types.RemoveSourceIdentifierFromSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<RDS.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
916 /**
917 * Removes a source identifier from an existing RDS event notification subscription.
918 */
919 removeSourceIdentifierFromSubscription(callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<RDS.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
920 /**
921 * 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.
922 */
923 removeTagsFromResource(params: RDS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
924 /**
925 * 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.
926 */
927 removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
928 /**
929 * 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.
930 */
931 resetDBClusterParameterGroup(params: RDS.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
932 /**
933 * 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.
934 */
935 resetDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
936 /**
937 * 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.
938 */
939 resetDBParameterGroup(params: RDS.Types.ResetDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
940 /**
941 * 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.
942 */
943 resetDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
944 /**
945 * 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.
946 */
947 restoreDBClusterFromS3(params: RDS.Types.RestoreDBClusterFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
948 /**
949 * 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.
950 */
951 restoreDBClusterFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
952 /**
953 * 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. If you don't specify a security group, the new DB cluster is associated 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.
954 */
955 restoreDBClusterFromSnapshot(params: RDS.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
956 /**
957 * 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. If you don't specify a security group, the new DB cluster is associated 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.
958 */
959 restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
960 /**
961 * 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.
962 */
963 restoreDBClusterToPointInTime(params: RDS.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
964 /**
965 * 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.
966 */
967 restoreDBClusterToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
968 /**
969 * 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.
970 */
971 restoreDBInstanceFromDBSnapshot(params: RDS.Types.RestoreDBInstanceFromDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
972 /**
973 * 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.
974 */
975 restoreDBInstanceFromDBSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
976 /**
977 * 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.
978 */
979 restoreDBInstanceFromS3(params: RDS.Types.RestoreDBInstanceFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
980 /**
981 * 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.
982 */
983 restoreDBInstanceFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
984 /**
985 * 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.
986 */
987 restoreDBInstanceToPointInTime(params: RDS.Types.RestoreDBInstanceToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request<RDS.Types.RestoreDBInstanceToPointInTimeResult, AWSError>;
988 /**
989 * 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.
990 */
991 restoreDBInstanceToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request<RDS.Types.RestoreDBInstanceToPointInTimeResult, AWSError>;
992 /**
993 * 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).
994 */
995 revokeDBSecurityGroupIngress(params: RDS.Types.RevokeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request<RDS.Types.RevokeDBSecurityGroupIngressResult, AWSError>;
996 /**
997 * 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).
998 */
999 revokeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request<RDS.Types.RevokeDBSecurityGroupIngressResult, AWSError>;
1000 /**
1001 * Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
1002 */
1003 startActivityStream(params: RDS.Types.StartActivityStreamRequest, callback?: (err: AWSError, data: RDS.Types.StartActivityStreamResponse) => void): Request<RDS.Types.StartActivityStreamResponse, AWSError>;
1004 /**
1005 * Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
1006 */
1007 startActivityStream(callback?: (err: AWSError, data: RDS.Types.StartActivityStreamResponse) => void): Request<RDS.Types.StartActivityStreamResponse, AWSError>;
1008 /**
1009 * 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.
1010 */
1011 startDBCluster(params: RDS.Types.StartDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request<RDS.Types.StartDBClusterResult, AWSError>;
1012 /**
1013 * 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.
1014 */
1015 startDBCluster(callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request<RDS.Types.StartDBClusterResult, AWSError>;
1016 /**
1017 * 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.
1018 */
1019 startDBInstance(params: RDS.Types.StartDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
1020 /**
1021 * 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.
1022 */
1023 startDBInstance(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
1024 /**
1025 * Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
1026 */
1027 startExportTask(params: RDS.Types.StartExportTaskMessage, callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
1028 /**
1029 * Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
1030 */
1031 startExportTask(callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
1032 /**
1033 * Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS CLI command, or the StartActivityStream action. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
1034 */
1035 stopActivityStream(params: RDS.Types.StopActivityStreamRequest, callback?: (err: AWSError, data: RDS.Types.StopActivityStreamResponse) => void): Request<RDS.Types.StopActivityStreamResponse, AWSError>;
1036 /**
1037 * Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS CLI command, or the StartActivityStream action. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
1038 */
1039 stopActivityStream(callback?: (err: AWSError, data: RDS.Types.StopActivityStreamResponse) => void): Request<RDS.Types.StopActivityStreamResponse, AWSError>;
1040 /**
1041 * 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.
1042 */
1043 stopDBCluster(params: RDS.Types.StopDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request<RDS.Types.StopDBClusterResult, AWSError>;
1044 /**
1045 * 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.
1046 */
1047 stopDBCluster(callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request<RDS.Types.StopDBClusterResult, AWSError>;
1048 /**
1049 * 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.
1050 */
1051 stopDBInstance(params: RDS.Types.StopDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
1052 /**
1053 * 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.
1054 */
1055 stopDBInstance(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
1056 /**
1057 * Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
1058 */
1059 waitFor(state: "dBInstanceAvailable", params: RDS.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
1060 /**
1061 * Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
1062 */
1063 waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
1064 /**
1065 * Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
1066 */
1067 waitFor(state: "dBInstanceDeleted", params: RDS.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
1068 /**
1069 * Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
1070 */
1071 waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
1072 /**
1073 * Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
1074 */
1075 waitFor(state: "dBSnapshotAvailable", params: RDS.Types.DescribeDBSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
1076 /**
1077 * Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
1078 */
1079 waitFor(state: "dBSnapshotAvailable", callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
1080 /**
1081 * Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
1082 */
1083 waitFor(state: "dBSnapshotDeleted", params: RDS.Types.DescribeDBSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
1084 /**
1085 * Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
1086 */
1087 waitFor(state: "dBSnapshotDeleted", callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
1088 /**
1089 * Waits for the dBClusterSnapshotAvailable state by periodically calling the underlying RDS.describeDBClusterSnapshotsoperation every 30 seconds (at most 60 times).
1090 */
1091 waitFor(state: "dBClusterSnapshotAvailable", params: RDS.Types.DescribeDBClusterSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
1092 /**
1093 * Waits for the dBClusterSnapshotAvailable state by periodically calling the underlying RDS.describeDBClusterSnapshotsoperation every 30 seconds (at most 60 times).
1094 */
1095 waitFor(state: "dBClusterSnapshotAvailable", callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
1096 /**
1097 * Waits for the dBClusterSnapshotDeleted state by periodically calling the underlying RDS.describeDBClusterSnapshotsoperation every 30 seconds (at most 60 times).
1098 */
1099 waitFor(state: "dBClusterSnapshotDeleted", params: RDS.Types.DescribeDBClusterSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
1100 /**
1101 * Waits for the dBClusterSnapshotDeleted state by periodically calling the underlying RDS.describeDBClusterSnapshotsoperation every 30 seconds (at most 60 times).
1102 */
1103 waitFor(state: "dBClusterSnapshotDeleted", callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
1104}
1105declare namespace RDS {
1106 export import Signer = signer;
1107}
1108declare namespace RDS {
1109 export interface AccountAttributesMessage {
1110 /**
1111 * 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.
1112 */
1113 AccountQuotas?: AccountQuotaList;
1114 }
1115 export interface AccountQuota {
1116 /**
1117 * The name of the Amazon RDS quota for this AWS account.
1118 */
1119 AccountQuotaName?: String;
1120 /**
1121 * The amount currently used toward the quota maximum.
1122 */
1123 Used?: Long;
1124 /**
1125 * The maximum allowed value for the quota.
1126 */
1127 Max?: Long;
1128 }
1129 export type AccountQuotaList = AccountQuota[];
1130 export type ActivityStreamMode = "sync"|"async"|string;
1131 export type ActivityStreamStatus = "stopped"|"starting"|"started"|"stopping"|string;
1132 export interface AddRoleToDBClusterMessage {
1133 /**
1134 * The name of the DB cluster to associate the IAM role with.
1135 */
1136 DBClusterIdentifier: String;
1137 /**
1138 * The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
1139 */
1140 RoleArn: String;
1141 /**
1142 * The name of the feature for the DB cluster that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.
1143 */
1144 FeatureName?: String;
1145 }
1146 export interface AddRoleToDBInstanceMessage {
1147 /**
1148 * The name of the DB instance to associate the IAM role with.
1149 */
1150 DBInstanceIdentifier: String;
1151 /**
1152 * The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
1153 */
1154 RoleArn: String;
1155 /**
1156 * 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.
1157 */
1158 FeatureName: String;
1159 }
1160 export interface AddSourceIdentifierToSubscriptionMessage {
1161 /**
1162 * The name of the RDS event notification subscription you want to add a source identifier to.
1163 */
1164 SubscriptionName: String;
1165 /**
1166 * 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.
1167 */
1168 SourceIdentifier: String;
1169 }
1170 export interface AddSourceIdentifierToSubscriptionResult {
1171 EventSubscription?: EventSubscription;
1172 }
1173 export interface AddTagsToResourceMessage {
1174 /**
1175 * 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).
1176 */
1177 ResourceName: String;
1178 /**
1179 * The tags to be assigned to the Amazon RDS resource.
1180 */
1181 Tags: TagList;
1182 }
1183 export type ApplyMethod = "immediate"|"pending-reboot"|string;
1184 export interface ApplyPendingMaintenanceActionMessage {
1185 /**
1186 * 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).
1187 */
1188 ResourceIdentifier: String;
1189 /**
1190 * The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
1191 */
1192 ApplyAction: String;
1193 /**
1194 * 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.
1195 */
1196 OptInType: String;
1197 }
1198 export interface ApplyPendingMaintenanceActionResult {
1199 ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions;
1200 }
1201 export type AttributeValueList = String[];
1202 export type AuthScheme = "SECRETS"|string;
1203 export interface AuthorizeDBSecurityGroupIngressMessage {
1204 /**
1205 * The name of the DB security group to add authorization to.
1206 */
1207 DBSecurityGroupName: String;
1208 /**
1209 * The IP range to authorize.
1210 */
1211 CIDRIP?: String;
1212 /**
1213 * 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.
1214 */
1215 EC2SecurityGroupName?: String;
1216 /**
1217 * 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.
1218 */
1219 EC2SecurityGroupId?: String;
1220 /**
1221 * AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
1222 */
1223 EC2SecurityGroupOwnerId?: String;
1224 }
1225 export interface AuthorizeDBSecurityGroupIngressResult {
1226 DBSecurityGroup?: DBSecurityGroup;
1227 }
1228 export interface AvailabilityZone {
1229 /**
1230 * The name of the Availability Zone.
1231 */
1232 Name?: String;
1233 }
1234 export type AvailabilityZoneList = AvailabilityZone[];
1235 export type AvailabilityZones = String[];
1236 export interface AvailableProcessorFeature {
1237 /**
1238 * The name of the processor feature. Valid names are coreCount and threadsPerCore.
1239 */
1240 Name?: String;
1241 /**
1242 * The default value for the processor feature of the DB instance class.
1243 */
1244 DefaultValue?: String;
1245 /**
1246 * The allowed values for the processor feature of the DB instance class.
1247 */
1248 AllowedValues?: String;
1249 }
1250 export type AvailableProcessorFeatureList = AvailableProcessorFeature[];
1251 export interface BacktrackDBClusterMessage {
1252 /**
1253 * 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
1254 */
1255 DBClusterIdentifier: String;
1256 /**
1257 * 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 isn't 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
1258 */
1259 BacktrackTo: TStamp;
1260 /**
1261 * A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
1262 */
1263 Force?: BooleanOptional;
1264 /**
1265 * A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
1266 */
1267 UseEarliestTimeOnPointInTimeUnavailable?: BooleanOptional;
1268 }
1269 export type Boolean = boolean;
1270 export type BooleanOptional = boolean;
1271 export interface CancelExportTaskMessage {
1272 /**
1273 * The identifier of the snapshot export task to cancel.
1274 */
1275 ExportTaskIdentifier: String;
1276 }
1277 export interface Certificate {
1278 /**
1279 * The unique key that identifies a certificate.
1280 */
1281 CertificateIdentifier?: String;
1282 /**
1283 * The type of the certificate.
1284 */
1285 CertificateType?: String;
1286 /**
1287 * The thumbprint of the certificate.
1288 */
1289 Thumbprint?: String;
1290 /**
1291 * The starting date from which the certificate is valid.
1292 */
1293 ValidFrom?: TStamp;
1294 /**
1295 * The final date that the certificate continues to be valid.
1296 */
1297 ValidTill?: TStamp;
1298 /**
1299 * The Amazon Resource Name (ARN) for the certificate.
1300 */
1301 CertificateArn?: String;
1302 /**
1303 * Whether there is an override for the default certificate identifier.
1304 */
1305 CustomerOverride?: BooleanOptional;
1306 /**
1307 * If there is an override for the default certificate identifier, when the override expires.
1308 */
1309 CustomerOverrideValidTill?: TStamp;
1310 }
1311 export type CertificateList = Certificate[];
1312 export interface CertificateMessage {
1313 /**
1314 * The list of Certificate objects for the AWS account.
1315 */
1316 Certificates?: CertificateList;
1317 /**
1318 * 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 .
1319 */
1320 Marker?: String;
1321 }
1322 export interface CharacterSet {
1323 /**
1324 * The name of the character set.
1325 */
1326 CharacterSetName?: String;
1327 /**
1328 * The description of the character set.
1329 */
1330 CharacterSetDescription?: String;
1331 }
1332 export interface CloudwatchLogsExportConfiguration {
1333 /**
1334 * The list of log types to enable.
1335 */
1336 EnableLogTypes?: LogTypeList;
1337 /**
1338 * The list of log types to disable.
1339 */
1340 DisableLogTypes?: LogTypeList;
1341 }
1342 export interface ConnectionPoolConfiguration {
1343 /**
1344 * The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. Default: 100 Constraints: between 1 and 100
1345 */
1346 MaxConnectionsPercent?: IntegerOptional;
1347 /**
1348 * Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. Default: 50 Constraints: between 0 and MaxConnectionsPercent
1349 */
1350 MaxIdleConnectionsPercent?: IntegerOptional;
1351 /**
1352 * The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. Default: 120 Constraints: between 1 and 3600, or 0 representing unlimited
1353 */
1354 ConnectionBorrowTimeout?: IntegerOptional;
1355 /**
1356 * Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Default: no session pinning filters
1357 */
1358 SessionPinningFilters?: StringList;
1359 /**
1360 * One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2. Default: no initialization query
1361 */
1362 InitQuery?: String;
1363 }
1364 export interface ConnectionPoolConfigurationInfo {
1365 /**
1366 * The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
1367 */
1368 MaxConnectionsPercent?: Integer;
1369 /**
1370 * Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
1371 */
1372 MaxIdleConnectionsPercent?: Integer;
1373 /**
1374 * The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
1375 */
1376 ConnectionBorrowTimeout?: Integer;
1377 /**
1378 * Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
1379 */
1380 SessionPinningFilters?: StringList;
1381 /**
1382 * One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
1383 */
1384 InitQuery?: String;
1385 }
1386 export interface CopyDBClusterParameterGroupMessage {
1387 /**
1388 * 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.
1389 */
1390 SourceDBClusterParameterGroupIdentifier: String;
1391 /**
1392 * 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
1393 */
1394 TargetDBClusterParameterGroupIdentifier: String;
1395 /**
1396 * A description for the copied DB cluster parameter group.
1397 */
1398 TargetDBClusterParameterGroupDescription: String;
1399 Tags?: TagList;
1400 }
1401 export interface CopyDBClusterParameterGroupResult {
1402 DBClusterParameterGroup?: DBClusterParameterGroup;
1403 }
1404 export interface CopyDBClusterSnapshotMessage {
1405 /**
1406 * The identifier of the DB cluster snapshot to copy. This parameter isn't 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
1407 */
1408 SourceDBClusterSnapshotIdentifier: String;
1409 /**
1410 * The identifier of the new DB cluster snapshot to create from the source 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-cluster-snapshot2
1411 */
1412 TargetDBClusterSnapshotIdentifier: String;
1413 /**
1414 * The 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.
1415 */
1416 KmsKeyId?: String;
1417 /**
1418 * 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. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same 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 is to 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 are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
1419 */
1420 PreSignedUrl?: String;
1421 /**
1422 * A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
1423 */
1424 CopyTags?: BooleanOptional;
1425 Tags?: TagList;
1426 /**
1427 * The ID of the region that contains the snapshot to be copied.
1428 */
1429 SourceRegion?: String;
1430 }
1431 export interface CopyDBClusterSnapshotResult {
1432 DBClusterSnapshot?: DBClusterSnapshot;
1433 }
1434 export interface CopyDBParameterGroupMessage {
1435 /**
1436 * 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.
1437 */
1438 SourceDBParameterGroupIdentifier: String;
1439 /**
1440 * 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
1441 */
1442 TargetDBParameterGroupIdentifier: String;
1443 /**
1444 * A description for the copied DB parameter group.
1445 */
1446 TargetDBParameterGroupDescription: String;
1447 Tags?: TagList;
1448 }
1449 export interface CopyDBParameterGroupResult {
1450 DBParameterGroup?: DBParameterGroup;
1451 }
1452 export interface CopyDBSnapshotMessage {
1453 /**
1454 * 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
1455 */
1456 SourceDBSnapshotIdentifier: String;
1457 /**
1458 * 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
1459 */
1460 TargetDBSnapshotIdentifier: String;
1461 /**
1462 * 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.
1463 */
1464 KmsKeyId?: String;
1465 Tags?: TagList;
1466 /**
1467 * A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
1468 */
1469 CopyTags?: BooleanOptional;
1470 /**
1471 * 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. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region. 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 are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
1472 */
1473 PreSignedUrl?: String;
1474 /**
1475 * 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.
1476 */
1477 OptionGroupName?: String;
1478 /**
1479 * The ID of the region that contains the snapshot to be copied.
1480 */
1481 SourceRegion?: String;
1482 }
1483 export interface CopyDBSnapshotResult {
1484 DBSnapshot?: DBSnapshot;
1485 }
1486 export interface CopyOptionGroupMessage {
1487 /**
1488 * 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.
1489 */
1490 SourceOptionGroupIdentifier: String;
1491 /**
1492 * 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
1493 */
1494 TargetOptionGroupIdentifier: String;
1495 /**
1496 * The description for the copied option group.
1497 */
1498 TargetOptionGroupDescription: String;
1499 Tags?: TagList;
1500 }
1501 export interface CopyOptionGroupResult {
1502 OptionGroup?: OptionGroup;
1503 }
1504 export interface CreateCustomAvailabilityZoneMessage {
1505 /**
1506 * The name of the custom Availability Zone (AZ).
1507 */
1508 CustomAvailabilityZoneName: String;
1509 /**
1510 * The ID of an existing virtual private network (VPN) between the Amazon RDS website and the VMware vSphere cluster.
1511 */
1512 ExistingVpnId?: String;
1513 /**
1514 * The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster. Specify this parameter only if ExistingVpnId isn't specified.
1515 */
1516 NewVpnTunnelName?: String;
1517 /**
1518 * The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic. Specify this parameter only if ExistingVpnId isn't specified.
1519 */
1520 VpnTunnelOriginatorIP?: String;
1521 }
1522 export interface CreateCustomAvailabilityZoneResult {
1523 CustomAvailabilityZone?: CustomAvailabilityZone;
1524 }
1525 export interface CreateDBClusterEndpointMessage {
1526 /**
1527 * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
1528 */
1529 DBClusterIdentifier: String;
1530 /**
1531 * The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
1532 */
1533 DBClusterEndpointIdentifier: String;
1534 /**
1535 * The type of the endpoint. One of: READER, WRITER, ANY.
1536 */
1537 EndpointType: String;
1538 /**
1539 * List of DB instance identifiers that are part of the custom endpoint group.
1540 */
1541 StaticMembers?: StringList;
1542 /**
1543 * 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.
1544 */
1545 ExcludedMembers?: StringList;
1546 /**
1547 * The tags to be assigned to the Amazon RDS resource.
1548 */
1549 Tags?: TagList;
1550 }
1551 export interface CreateDBClusterMessage {
1552 /**
1553 * A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
1554 */
1555 AvailabilityZones?: AvailabilityZones;
1556 /**
1557 * The number of days for which automated backups are retained. Default: 1 Constraints: Must be a value from 1 to 35
1558 */
1559 BackupRetentionPeriod?: IntegerOptional;
1560 /**
1561 * A value that indicates that the DB cluster should be associated with the specified CharacterSet.
1562 */
1563 CharacterSetName?: String;
1564 /**
1565 * The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
1566 */
1567 DatabaseName?: String;
1568 /**
1569 * 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
1570 */
1571 DBClusterIdentifier: String;
1572 /**
1573 * The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group.
1574 */
1575 DBClusterParameterGroupName?: String;
1576 /**
1577 * A list of EC2 VPC security groups to associate with this DB cluster.
1578 */
1579 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1580 /**
1581 * 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
1582 */
1583 DBSubnetGroupName?: String;
1584 /**
1585 * 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
1586 */
1587 Engine: String;
1588 /**
1589 * The version number of the database engine to use. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" Aurora MySQL Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5 Aurora PostgreSQL Example: 9.6.3, 10.7
1590 */
1591 EngineVersion?: String;
1592 /**
1593 * 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.
1594 */
1595 Port?: IntegerOptional;
1596 /**
1597 * 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.
1598 */
1599 MasterUsername?: String;
1600 /**
1601 * 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.
1602 */
1603 MasterUserPassword?: String;
1604 /**
1605 * 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.
1606 */
1607 OptionGroupName?: String;
1608 /**
1609 * 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.
1610 */
1611 PreferredBackupWindow?: String;
1612 /**
1613 * 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.
1614 */
1615 PreferredMaintenanceWindow?: String;
1616 /**
1617 * The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
1618 */
1619 ReplicationSourceIdentifier?: String;
1620 /**
1621 * Tags to assign to the DB cluster.
1622 */
1623 Tags?: TagList;
1624 /**
1625 * A value that indicates whether the DB cluster is encrypted.
1626 */
1627 StorageEncrypted?: BooleanOptional;
1628 /**
1629 * 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 isn't 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 enabled and ReplicationSourceIdentifier isn't 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.
1630 */
1631 KmsKeyId?: String;
1632 /**
1633 * 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 are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
1634 */
1635 PreSignedUrl?: String;
1636 /**
1637 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
1638 */
1639 EnableIAMDatabaseAuthentication?: BooleanOptional;
1640 /**
1641 * 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).
1642 */
1643 BacktrackWindow?: LongOptional;
1644 /**
1645 * 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.
1646 */
1647 EnableCloudwatchLogsExports?: LogTypeList;
1648 /**
1649 * The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless Limitations of Parallel Query Requirements for Aurora Global Databases Limitations of Multi-Master Clusters
1650 */
1651 EngineMode?: String;
1652 /**
1653 * For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
1654 */
1655 ScalingConfiguration?: ScalingConfiguration;
1656 /**
1657 * A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
1658 */
1659 DeletionProtection?: BooleanOptional;
1660 /**
1661 * The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
1662 */
1663 GlobalClusterIdentifier?: String;
1664 /**
1665 * 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, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
1666 */
1667 EnableHttpEndpoint?: BooleanOptional;
1668 /**
1669 * A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
1670 */
1671 CopyTagsToSnapshot?: BooleanOptional;
1672 /**
1673 * The Active Directory directory ID to create the DB cluster in. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Using Kerberos Authentication for Aurora MySQL in the Amazon Aurora User Guide.
1674 */
1675 Domain?: String;
1676 /**
1677 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
1678 */
1679 DomainIAMRoleName?: String;
1680 /**
1681 * The ID of the region that contains the source for the read replica.
1682 */
1683 SourceRegion?: String;
1684 }
1685 export interface CreateDBClusterParameterGroupMessage {
1686 /**
1687 * 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.
1688 */
1689 DBClusterParameterGroupName: String;
1690 /**
1691 * 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
1692 */
1693 DBParameterGroupFamily: String;
1694 /**
1695 * The description for the DB cluster parameter group.
1696 */
1697 Description: String;
1698 /**
1699 * Tags to assign to the DB cluster parameter group.
1700 */
1701 Tags?: TagList;
1702 }
1703 export interface CreateDBClusterParameterGroupResult {
1704 DBClusterParameterGroup?: DBClusterParameterGroup;
1705 }
1706 export interface CreateDBClusterResult {
1707 DBCluster?: DBCluster;
1708 }
1709 export interface CreateDBClusterSnapshotMessage {
1710 /**
1711 * 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
1712 */
1713 DBClusterSnapshotIdentifier: String;
1714 /**
1715 * The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster1
1716 */
1717 DBClusterIdentifier: String;
1718 /**
1719 * The tags to be assigned to the DB cluster snapshot.
1720 */
1721 Tags?: TagList;
1722 }
1723 export interface CreateDBClusterSnapshotResult {
1724 DBClusterSnapshot?: DBClusterSnapshot;
1725 }
1726 export interface CreateDBInstanceMessage {
1727 /**
1728 * The meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. 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 isn't 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 isn't 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 isn't 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
1729 */
1730 DBName?: String;
1731 /**
1732 * 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
1733 */
1734 DBInstanceIdentifier: String;
1735 /**
1736 * 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 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. 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 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. 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 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. 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 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. 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.
1737 */
1738 AllocatedStorage?: IntegerOptional;
1739 /**
1740 * 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.
1741 */
1742 DBInstanceClass: String;
1743 /**
1744 * 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
1745 */
1746 Engine: String;
1747 /**
1748 * The name for the master user. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. 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.
1749 */
1750 MasterUsername?: String;
1751 /**
1752 * 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. 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.
1753 */
1754 MasterUserPassword?: String;
1755 /**
1756 * A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
1757 */
1758 DBSecurityGroups?: DBSecurityGroupNameList;
1759 /**
1760 * 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. Default: The default EC2 VPC security group for the DB subnet group's VPC.
1761 */
1762 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1763 /**
1764 * The Availability Zone (AZ) where the database will be created. 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 DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint. If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in. For more information about RDS on VMware, see the RDS on VMware User Guide.
1765 */
1766 AvailabilityZone?: String;
1767 /**
1768 * 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.
1769 */
1770 DBSubnetGroupName?: String;
1771 /**
1772 * 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.
1773 */
1774 PreferredMaintenanceWindow?: String;
1775 /**
1776 * The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version 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
1777 */
1778 DBParameterGroupName?: String;
1779 /**
1780 * 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. 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
1781 */
1782 BackupRetentionPeriod?: IntegerOptional;
1783 /**
1784 * 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. 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.
1785 */
1786 PreferredBackupWindow?: String;
1787 /**
1788 * 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
1789 */
1790 Port?: IntegerOptional;
1791 /**
1792 * A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
1793 */
1794 MultiAZ?: BooleanOptional;
1795 /**
1796 * The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. 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. 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.
1797 */
1798 EngineVersion?: String;
1799 /**
1800 * A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
1801 */
1802 AutoMinorVersionUpgrade?: BooleanOptional;
1803 /**
1804 * License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license
1805 */
1806 LicenseModel?: String;
1807 /**
1808 * 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 Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
1809 */
1810 Iops?: IntegerOptional;
1811 /**
1812 * 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. Also, that option group can't be removed from a DB instance once it is associated with a DB instance
1813 */
1814 OptionGroupName?: String;
1815 /**
1816 * 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.
1817 */
1818 CharacterSetName?: String;
1819 /**
1820 * A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is 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 isn't specified, and PubliclyAccessible isn't 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 isn't 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.
1821 */
1822 PubliclyAccessible?: BooleanOptional;
1823 /**
1824 * Tags to assign to the DB instance.
1825 */
1826 Tags?: TagList;
1827 /**
1828 * The identifier of the DB cluster that the instance will belong to.
1829 */
1830 DBClusterIdentifier?: String;
1831 /**
1832 * 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 gp2
1833 */
1834 StorageType?: String;
1835 /**
1836 * The ARN from the key store with which to associate the instance for TDE encryption.
1837 */
1838 TdeCredentialArn?: String;
1839 /**
1840 * The password for the given ARN from the key store in order to access the device.
1841 */
1842 TdeCredentialPassword?: String;
1843 /**
1844 * A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster.
1845 */
1846 StorageEncrypted?: BooleanOptional;
1847 /**
1848 * 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 StorageEncrypted is enabled, 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.
1849 */
1850 KmsKeyId?: String;
1851 /**
1852 * The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain. For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide. For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
1853 */
1854 Domain?: String;
1855 /**
1856 * A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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.
1857 */
1858 CopyTagsToSnapshot?: BooleanOptional;
1859 /**
1860 * 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
1861 */
1862 MonitoringInterval?: IntegerOptional;
1863 /**
1864 * 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.
1865 */
1866 MonitoringRoleArn?: String;
1867 /**
1868 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
1869 */
1870 DomainIAMRoleName?: String;
1871 /**
1872 * 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
1873 */
1874 PromotionTier?: IntegerOptional;
1875 /**
1876 * The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
1877 */
1878 Timezone?: String;
1879 /**
1880 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. 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. MySQL For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher For MySQL 8.0, minor version 8.0.16 or higher PostgreSQL For PostgreSQL 9.5, minor version 9.5.15 or higher For PostgreSQL 9.6, minor version 9.6.11 or higher PostgreSQL 10.6, 10.7, and 10.9 For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
1881 */
1882 EnableIAMDatabaseAuthentication?: BooleanOptional;
1883 /**
1884 * A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
1885 */
1886 EnablePerformanceInsights?: BooleanOptional;
1887 /**
1888 * 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. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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.
1889 */
1890 PerformanceInsightsKMSKeyId?: String;
1891 /**
1892 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
1893 */
1894 PerformanceInsightsRetentionPeriod?: IntegerOptional;
1895 /**
1896 * 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.
1897 */
1898 EnableCloudwatchLogsExports?: LogTypeList;
1899 /**
1900 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
1901 */
1902 ProcessorFeatures?: ProcessorFeatureList;
1903 /**
1904 * A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
1905 */
1906 DeletionProtection?: BooleanOptional;
1907 /**
1908 * The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
1909 */
1910 MaxAllocatedStorage?: IntegerOptional;
1911 }
1912 export interface CreateDBInstanceReadReplicaMessage {
1913 /**
1914 * 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.
1915 */
1916 DBInstanceIdentifier: String;
1917 /**
1918 * 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, Oracle, 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. For the limitations of Oracle Read Replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide. 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.
1919 */
1920 SourceDBInstanceIdentifier: String;
1921 /**
1922 * 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.
1923 */
1924 DBInstanceClass?: String;
1925 /**
1926 * The Availability Zone (AZ) where the Read Replica will be created. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d
1927 */
1928 AvailabilityZone?: String;
1929 /**
1930 * The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535
1931 */
1932 Port?: IntegerOptional;
1933 /**
1934 * A value that indicates 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.
1935 */
1936 MultiAZ?: BooleanOptional;
1937 /**
1938 * A value that indicates whether minor engine upgrades are applied automatically to the Read Replica during the maintenance window. Default: Inherits from the source DB instance
1939 */
1940 AutoMinorVersionUpgrade?: BooleanOptional;
1941 /**
1942 * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
1943 */
1944 Iops?: IntegerOptional;
1945 /**
1946 * The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
1947 */
1948 OptionGroupName?: String;
1949 /**
1950 * The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region Read Replica, or the default DBParameterGroup for the specified DB engine for a cross region Read Replica. Currently, specifying a parameter group for this operation is only supported for Oracle DB instances. 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
1951 */
1952 DBParameterGroupName?: String;
1953 /**
1954 * A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
1955 */
1956 PubliclyAccessible?: BooleanOptional;
1957 Tags?: TagList;
1958 /**
1959 * Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC. 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
1960 */
1961 DBSubnetGroupName?: String;
1962 /**
1963 * 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.
1964 */
1965 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
1966 /**
1967 * 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 gp2
1968 */
1969 StorageType?: String;
1970 /**
1971 * A value that indicates whether to copy all tags from the Read Replica to snapshots of the Read Replica. By default, tags are not copied.
1972 */
1973 CopyTagsToSnapshot?: BooleanOptional;
1974 /**
1975 * 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
1976 */
1977 MonitoringInterval?: IntegerOptional;
1978 /**
1979 * 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.
1980 */
1981 MonitoringRoleArn?: String;
1982 /**
1983 * 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.
1984 */
1985 KmsKeyId?: String;
1986 /**
1987 * 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. Don't specify PreSignedUrl when you are creating an encrypted Read Replica in the same AWS Region. 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 are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
1988 */
1989 PreSignedUrl?: String;
1990 /**
1991 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
1992 */
1993 EnableIAMDatabaseAuthentication?: BooleanOptional;
1994 /**
1995 * A value that indicates whether to enable Performance Insights for the Read Replica. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
1996 */
1997 EnablePerformanceInsights?: BooleanOptional;
1998 /**
1999 * 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. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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.
2000 */
2001 PerformanceInsightsKMSKeyId?: String;
2002 /**
2003 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
2004 */
2005 PerformanceInsightsRetentionPeriod?: IntegerOptional;
2006 /**
2007 * 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.
2008 */
2009 EnableCloudwatchLogsExports?: LogTypeList;
2010 /**
2011 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
2012 */
2013 ProcessorFeatures?: ProcessorFeatureList;
2014 /**
2015 * A value that indicates whether the DB instance class of the DB instance uses its default processor features.
2016 */
2017 UseDefaultProcessorFeatures?: BooleanOptional;
2018 /**
2019 * A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
2020 */
2021 DeletionProtection?: BooleanOptional;
2022 /**
2023 * The Active Directory directory ID to create the DB instance in. For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
2024 */
2025 Domain?: String;
2026 /**
2027 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
2028 */
2029 DomainIAMRoleName?: String;
2030 /**
2031 * The ID of the region that contains the source for the read replica.
2032 */
2033 SourceRegion?: String;
2034 }
2035 export interface CreateDBInstanceReadReplicaResult {
2036 DBInstance?: DBInstance;
2037 }
2038 export interface CreateDBInstanceResult {
2039 DBInstance?: DBInstance;
2040 }
2041 export interface CreateDBParameterGroupMessage {
2042 /**
2043 * 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.
2044 */
2045 DBParameterGroupName: String;
2046 /**
2047 * 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.
2048 */
2049 DBParameterGroupFamily: String;
2050 /**
2051 * The description for the DB parameter group.
2052 */
2053 Description: String;
2054 /**
2055 * Tags to assign to the DB parameter group.
2056 */
2057 Tags?: TagList;
2058 }
2059 export interface CreateDBParameterGroupResult {
2060 DBParameterGroup?: DBParameterGroup;
2061 }
2062 export interface CreateDBProxyRequest {
2063 /**
2064 * The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
2065 */
2066 DBProxyName: String;
2067 /**
2068 * The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. Currently, this value is always MYSQL. The engine family applies to both RDS MySQL and Aurora MySQL.
2069 */
2070 EngineFamily: EngineFamily;
2071 /**
2072 * The authorization mechanism that the proxy uses.
2073 */
2074 Auth: UserAuthConfigList;
2075 /**
2076 * The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
2077 */
2078 RoleArn: String;
2079 /**
2080 * One or more VPC subnet IDs to associate with the new proxy.
2081 */
2082 VpcSubnetIds: StringList;
2083 /**
2084 * One or more VPC security group IDs to associate with the new proxy.
2085 */
2086 VpcSecurityGroupIds?: StringList;
2087 /**
2088 * A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
2089 */
2090 RequireTLS?: Boolean;
2091 /**
2092 * The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
2093 */
2094 IdleClientTimeout?: IntegerOptional;
2095 /**
2096 * Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
2097 */
2098 DebugLogging?: Boolean;
2099 /**
2100 * An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
2101 */
2102 Tags?: TagList;
2103 }
2104 export interface CreateDBProxyResponse {
2105 /**
2106 * The DBProxy structure corresponding to the new proxy.
2107 */
2108 DBProxy?: DBProxy;
2109 }
2110 export interface CreateDBSecurityGroupMessage {
2111 /**
2112 * 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
2113 */
2114 DBSecurityGroupName: String;
2115 /**
2116 * The description for the DB security group.
2117 */
2118 DBSecurityGroupDescription: String;
2119 /**
2120 * Tags to assign to the DB security group.
2121 */
2122 Tags?: TagList;
2123 }
2124 export interface CreateDBSecurityGroupResult {
2125 DBSecurityGroup?: DBSecurityGroup;
2126 }
2127 export interface CreateDBSnapshotMessage {
2128 /**
2129 * 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
2130 */
2131 DBSnapshotIdentifier: String;
2132 /**
2133 * The identifier of the DB instance that you want to create the snapshot of. Constraints: Must match the identifier of an existing DBInstance.
2134 */
2135 DBInstanceIdentifier: String;
2136 Tags?: TagList;
2137 }
2138 export interface CreateDBSnapshotResult {
2139 DBSnapshot?: DBSnapshot;
2140 }
2141 export interface CreateDBSubnetGroupMessage {
2142 /**
2143 * 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
2144 */
2145 DBSubnetGroupName: String;
2146 /**
2147 * The description for the DB subnet group.
2148 */
2149 DBSubnetGroupDescription: String;
2150 /**
2151 * The EC2 Subnet IDs for the DB subnet group.
2152 */
2153 SubnetIds: SubnetIdentifierList;
2154 /**
2155 * Tags to assign to the DB subnet group.
2156 */
2157 Tags?: TagList;
2158 }
2159 export interface CreateDBSubnetGroupResult {
2160 DBSubnetGroup?: DBSubnetGroup;
2161 }
2162 export interface CreateEventSubscriptionMessage {
2163 /**
2164 * The name of the subscription. Constraints: The name must be less than 255 characters.
2165 */
2166 SubscriptionName: String;
2167 /**
2168 * 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.
2169 */
2170 SnsTopicArn: String;
2171 /**
2172 * 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 isn't specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
2173 */
2174 SourceType?: String;
2175 /**
2176 * 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.
2177 */
2178 EventCategories?: EventCategoriesList;
2179 /**
2180 * 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.
2181 */
2182 SourceIds?: SourceIdsList;
2183 /**
2184 * A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
2185 */
2186 Enabled?: BooleanOptional;
2187 Tags?: TagList;
2188 }
2189 export interface CreateEventSubscriptionResult {
2190 EventSubscription?: EventSubscription;
2191 }
2192 export interface CreateGlobalClusterMessage {
2193 /**
2194 * The cluster identifier of the new global database cluster.
2195 */
2196 GlobalClusterIdentifier?: String;
2197 /**
2198 * The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.
2199 */
2200 SourceDBClusterIdentifier?: String;
2201 /**
2202 * Provides the name of the database engine to be used for this DB cluster.
2203 */
2204 Engine?: String;
2205 /**
2206 * The engine version of the Aurora global database.
2207 */
2208 EngineVersion?: String;
2209 /**
2210 * The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
2211 */
2212 DeletionProtection?: BooleanOptional;
2213 /**
2214 * 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.
2215 */
2216 DatabaseName?: String;
2217 /**
2218 * The storage encryption setting for the new global database cluster.
2219 */
2220 StorageEncrypted?: BooleanOptional;
2221 }
2222 export interface CreateGlobalClusterResult {
2223 GlobalCluster?: GlobalCluster;
2224 }
2225 export interface CreateOptionGroupMessage {
2226 /**
2227 * 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
2228 */
2229 OptionGroupName: String;
2230 /**
2231 * Specifies the name of the engine that this option group should be associated with.
2232 */
2233 EngineName: String;
2234 /**
2235 * Specifies the major version of the engine that this option group should be associated with.
2236 */
2237 MajorEngineVersion: String;
2238 /**
2239 * The description of the option group.
2240 */
2241 OptionGroupDescription: String;
2242 /**
2243 * Tags to assign to the option group.
2244 */
2245 Tags?: TagList;
2246 }
2247 export interface CreateOptionGroupResult {
2248 OptionGroup?: OptionGroup;
2249 }
2250 export interface CustomAvailabilityZone {
2251 /**
2252 * The identifier of the custom AZ. Amazon RDS generates a unique identifier when a custom AZ is created.
2253 */
2254 CustomAvailabilityZoneId?: String;
2255 /**
2256 * The name of the custom AZ.
2257 */
2258 CustomAvailabilityZoneName?: String;
2259 /**
2260 * The status of the custom AZ.
2261 */
2262 CustomAvailabilityZoneStatus?: String;
2263 /**
2264 * Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
2265 */
2266 VpnDetails?: VpnDetails;
2267 }
2268 export type CustomAvailabilityZoneList = CustomAvailabilityZone[];
2269 export interface CustomAvailabilityZoneMessage {
2270 /**
2271 * An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
2272 */
2273 Marker?: String;
2274 /**
2275 * The list of CustomAvailabilityZone objects for the AWS account.
2276 */
2277 CustomAvailabilityZones?: CustomAvailabilityZoneList;
2278 }
2279 export interface DBCluster {
2280 /**
2281 * 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 isn't fixed, but instead automatically adjusts as needed.
2282 */
2283 AllocatedStorage?: IntegerOptional;
2284 /**
2285 * Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
2286 */
2287 AvailabilityZones?: AvailabilityZones;
2288 /**
2289 * Specifies the number of days for which automatic DB snapshots are retained.
2290 */
2291 BackupRetentionPeriod?: IntegerOptional;
2292 /**
2293 * If present, specifies the name of the character set that this cluster is associated with.
2294 */
2295 CharacterSetName?: String;
2296 /**
2297 * 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.
2298 */
2299 DatabaseName?: String;
2300 /**
2301 * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
2302 */
2303 DBClusterIdentifier?: String;
2304 /**
2305 * Specifies the name of the DB cluster parameter group for the DB cluster.
2306 */
2307 DBClusterParameterGroup?: String;
2308 /**
2309 * Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
2310 */
2311 DBSubnetGroup?: String;
2312 /**
2313 * Specifies the current state of this DB cluster.
2314 */
2315 Status?: String;
2316 /**
2317 * Specifies the progress of the operation as a percentage.
2318 */
2319 PercentProgress?: String;
2320 /**
2321 * The earliest time to which a database can be restored with point-in-time restore.
2322 */
2323 EarliestRestorableTime?: TStamp;
2324 /**
2325 * Specifies the connection endpoint for the primary instance of the DB cluster.
2326 */
2327 Endpoint?: String;
2328 /**
2329 * 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.
2330 */
2331 ReaderEndpoint?: String;
2332 /**
2333 * Identifies all custom endpoints associated with the cluster.
2334 */
2335 CustomEndpoints?: StringList;
2336 /**
2337 * Specifies whether the DB cluster has instances in multiple Availability Zones.
2338 */
2339 MultiAZ?: BooleanOptional;
2340 /**
2341 * Provides the name of the database engine to be used for this DB cluster.
2342 */
2343 Engine?: String;
2344 /**
2345 * Indicates the database engine version.
2346 */
2347 EngineVersion?: String;
2348 /**
2349 * Specifies the latest time to which a database can be restored with point-in-time restore.
2350 */
2351 LatestRestorableTime?: TStamp;
2352 /**
2353 * Specifies the port that the database engine is listening on.
2354 */
2355 Port?: IntegerOptional;
2356 /**
2357 * Contains the master username for the DB cluster.
2358 */
2359 MasterUsername?: String;
2360 /**
2361 * Provides the list of option group memberships for this DB cluster.
2362 */
2363 DBClusterOptionGroupMemberships?: DBClusterOptionGroupMemberships;
2364 /**
2365 * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
2366 */
2367 PreferredBackupWindow?: String;
2368 /**
2369 * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
2370 */
2371 PreferredMaintenanceWindow?: String;
2372 /**
2373 * Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
2374 */
2375 ReplicationSourceIdentifier?: String;
2376 /**
2377 * Contains one or more identifiers of the Read Replicas associated with this DB cluster.
2378 */
2379 ReadReplicaIdentifiers?: ReadReplicaIdentifierList;
2380 /**
2381 * Provides the list of instances that make up the DB cluster.
2382 */
2383 DBClusterMembers?: DBClusterMemberList;
2384 /**
2385 * Provides a list of VPC security groups that the DB cluster belongs to.
2386 */
2387 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
2388 /**
2389 * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
2390 */
2391 HostedZoneId?: String;
2392 /**
2393 * Specifies whether the DB cluster is encrypted.
2394 */
2395 StorageEncrypted?: Boolean;
2396 /**
2397 * If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
2398 */
2399 KmsKeyId?: String;
2400 /**
2401 * 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.
2402 */
2403 DbClusterResourceId?: String;
2404 /**
2405 * The Amazon Resource Name (ARN) for the DB cluster.
2406 */
2407 DBClusterArn?: String;
2408 /**
2409 * 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.
2410 */
2411 AssociatedRoles?: DBClusterRoles;
2412 /**
2413 * A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
2414 */
2415 IAMDatabaseAuthenticationEnabled?: BooleanOptional;
2416 /**
2417 * Identifies the clone group to which the DB cluster is associated.
2418 */
2419 CloneGroupId?: String;
2420 /**
2421 * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
2422 */
2423 ClusterCreateTime?: TStamp;
2424 /**
2425 * The earliest time to which a DB cluster can be backtracked.
2426 */
2427 EarliestBacktrackTime?: TStamp;
2428 /**
2429 * The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
2430 */
2431 BacktrackWindow?: LongOptional;
2432 /**
2433 * The number of change records stored for Backtrack.
2434 */
2435 BacktrackConsumedChangeRecords?: LongOptional;
2436 /**
2437 * 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.
2438 */
2439 EnabledCloudwatchLogsExports?: LogTypeList;
2440 /**
2441 * 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.
2442 */
2443 Capacity?: IntegerOptional;
2444 /**
2445 * The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
2446 */
2447 EngineMode?: String;
2448 ScalingConfigurationInfo?: ScalingConfigurationInfo;
2449 /**
2450 * Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
2451 */
2452 DeletionProtection?: BooleanOptional;
2453 /**
2454 * A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled. 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, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
2455 */
2456 HttpEndpointEnabled?: BooleanOptional;
2457 /**
2458 * The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
2459 */
2460 ActivityStreamMode?: ActivityStreamMode;
2461 /**
2462 * The status of the database activity stream.
2463 */
2464 ActivityStreamStatus?: ActivityStreamStatus;
2465 /**
2466 * The AWS KMS key identifier used for encrypting messages in the database activity stream.
2467 */
2468 ActivityStreamKmsKeyId?: String;
2469 /**
2470 * The name of the Amazon Kinesis data stream used for the database activity stream.
2471 */
2472 ActivityStreamKinesisStreamName?: String;
2473 /**
2474 * Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
2475 */
2476 CopyTagsToSnapshot?: BooleanOptional;
2477 /**
2478 * Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.
2479 */
2480 CrossAccountClone?: BooleanOptional;
2481 /**
2482 * The Active Directory Domain membership records associated with the DB cluster.
2483 */
2484 DomainMemberships?: DomainMembershipList;
2485 }
2486 export interface DBClusterBacktrack {
2487 /**
2488 * Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
2489 */
2490 DBClusterIdentifier?: String;
2491 /**
2492 * Contains the backtrack identifier.
2493 */
2494 BacktrackIdentifier?: String;
2495 /**
2496 * The timestamp of the time to which the DB cluster was backtracked.
2497 */
2498 BacktrackTo?: TStamp;
2499 /**
2500 * The timestamp of the time from which the DB cluster was backtracked.
2501 */
2502 BacktrackedFrom?: TStamp;
2503 /**
2504 * The timestamp of the time at which the backtrack was requested.
2505 */
2506 BacktrackRequestCreationTime?: TStamp;
2507 /**
2508 * 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.
2509 */
2510 Status?: String;
2511 }
2512 export type DBClusterBacktrackList = DBClusterBacktrack[];
2513 export interface DBClusterBacktrackMessage {
2514 /**
2515 * A pagination token that can be used in a later DescribeDBClusterBacktracks request.
2516 */
2517 Marker?: String;
2518 /**
2519 * Contains a list of backtracks for the user.
2520 */
2521 DBClusterBacktracks?: DBClusterBacktrackList;
2522 }
2523 export interface DBClusterCapacityInfo {
2524 /**
2525 * A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
2526 */
2527 DBClusterIdentifier?: String;
2528 /**
2529 * A value that specifies the capacity that the DB cluster scales to next.
2530 */
2531 PendingCapacity?: IntegerOptional;
2532 /**
2533 * The current capacity of the DB cluster.
2534 */
2535 CurrentCapacity?: IntegerOptional;
2536 /**
2537 * The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
2538 */
2539 SecondsBeforeTimeout?: IntegerOptional;
2540 /**
2541 * The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
2542 */
2543 TimeoutAction?: String;
2544 }
2545 export interface DBClusterEndpoint {
2546 /**
2547 * The identifier associated with the endpoint. This parameter is stored as a lowercase string.
2548 */
2549 DBClusterEndpointIdentifier?: String;
2550 /**
2551 * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
2552 */
2553 DBClusterIdentifier?: String;
2554 /**
2555 * A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
2556 */
2557 DBClusterEndpointResourceIdentifier?: String;
2558 /**
2559 * The DNS address of the endpoint.
2560 */
2561 Endpoint?: String;
2562 /**
2563 * The current status of the endpoint. One of: creating, available, deleting, modifying.
2564 */
2565 Status?: String;
2566 /**
2567 * The type of the endpoint. One of: READER, WRITER, CUSTOM.
2568 */
2569 EndpointType?: String;
2570 /**
2571 * The type associated with a custom endpoint. One of: READER, WRITER, ANY.
2572 */
2573 CustomEndpointType?: String;
2574 /**
2575 * List of DB instance identifiers that are part of the custom endpoint group.
2576 */
2577 StaticMembers?: StringList;
2578 /**
2579 * 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.
2580 */
2581 ExcludedMembers?: StringList;
2582 /**
2583 * The Amazon Resource Name (ARN) for the endpoint.
2584 */
2585 DBClusterEndpointArn?: String;
2586 }
2587 export type DBClusterEndpointList = DBClusterEndpoint[];
2588 export interface DBClusterEndpointMessage {
2589 /**
2590 * 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.
2591 */
2592 Marker?: String;
2593 /**
2594 * Contains the details of the endpoints associated with the cluster and matching any filter conditions.
2595 */
2596 DBClusterEndpoints?: DBClusterEndpointList;
2597 }
2598 export type DBClusterList = DBCluster[];
2599 export interface DBClusterMember {
2600 /**
2601 * Specifies the instance identifier for this member of the DB cluster.
2602 */
2603 DBInstanceIdentifier?: String;
2604 /**
2605 * Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
2606 */
2607 IsClusterWriter?: Boolean;
2608 /**
2609 * Specifies the status of the DB cluster parameter group for this member of the DB cluster.
2610 */
2611 DBClusterParameterGroupStatus?: String;
2612 /**
2613 * 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.
2614 */
2615 PromotionTier?: IntegerOptional;
2616 }
2617 export type DBClusterMemberList = DBClusterMember[];
2618 export interface DBClusterMessage {
2619 /**
2620 * A pagination token that can be used in a later DescribeDBClusters request.
2621 */
2622 Marker?: String;
2623 /**
2624 * Contains a list of DB clusters for the user.
2625 */
2626 DBClusters?: DBClusterList;
2627 }
2628 export type DBClusterOptionGroupMemberships = DBClusterOptionGroupStatus[];
2629 export interface DBClusterOptionGroupStatus {
2630 /**
2631 * Specifies the name of the DB cluster option group.
2632 */
2633 DBClusterOptionGroupName?: String;
2634 /**
2635 * Specifies the status of the DB cluster option group.
2636 */
2637 Status?: String;
2638 }
2639 export interface DBClusterParameterGroup {
2640 /**
2641 * Provides the name of the DB cluster parameter group.
2642 */
2643 DBClusterParameterGroupName?: String;
2644 /**
2645 * Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
2646 */
2647 DBParameterGroupFamily?: String;
2648 /**
2649 * Provides the customer-specified description for this DB cluster parameter group.
2650 */
2651 Description?: String;
2652 /**
2653 * The Amazon Resource Name (ARN) for the DB cluster parameter group.
2654 */
2655 DBClusterParameterGroupArn?: String;
2656 }
2657 export interface DBClusterParameterGroupDetails {
2658 /**
2659 * Provides a list of parameters for the DB cluster parameter group.
2660 */
2661 Parameters?: ParametersList;
2662 /**
2663 * 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 .
2664 */
2665 Marker?: String;
2666 }
2667 export type DBClusterParameterGroupList = DBClusterParameterGroup[];
2668 export interface DBClusterParameterGroupNameMessage {
2669 /**
2670 * 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.
2671 */
2672 DBClusterParameterGroupName?: String;
2673 }
2674 export interface DBClusterParameterGroupsMessage {
2675 /**
2676 * 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.
2677 */
2678 Marker?: String;
2679 /**
2680 * A list of DB cluster parameter groups.
2681 */
2682 DBClusterParameterGroups?: DBClusterParameterGroupList;
2683 }
2684 export interface DBClusterRole {
2685 /**
2686 * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
2687 */
2688 RoleArn?: String;
2689 /**
2690 * 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.
2691 */
2692 Status?: String;
2693 /**
2694 * The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.
2695 */
2696 FeatureName?: String;
2697 }
2698 export type DBClusterRoles = DBClusterRole[];
2699 export interface DBClusterSnapshot {
2700 /**
2701 * Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
2702 */
2703 AvailabilityZones?: AvailabilityZones;
2704 /**
2705 * Specifies the identifier for the DB cluster snapshot.
2706 */
2707 DBClusterSnapshotIdentifier?: String;
2708 /**
2709 * Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
2710 */
2711 DBClusterIdentifier?: String;
2712 /**
2713 * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
2714 */
2715 SnapshotCreateTime?: TStamp;
2716 /**
2717 * Specifies the name of the database engine.
2718 */
2719 Engine?: String;
2720 /**
2721 * Specifies the allocated storage size in gibibytes (GiB).
2722 */
2723 AllocatedStorage?: Integer;
2724 /**
2725 * Specifies the status of this DB cluster snapshot.
2726 */
2727 Status?: String;
2728 /**
2729 * Specifies the port that the DB cluster was listening on at the time of the snapshot.
2730 */
2731 Port?: Integer;
2732 /**
2733 * Provides the VPC ID associated with the DB cluster snapshot.
2734 */
2735 VpcId?: String;
2736 /**
2737 * Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
2738 */
2739 ClusterCreateTime?: TStamp;
2740 /**
2741 * Provides the master username for the DB cluster snapshot.
2742 */
2743 MasterUsername?: String;
2744 /**
2745 * Provides the version of the database engine for this DB cluster snapshot.
2746 */
2747 EngineVersion?: String;
2748 /**
2749 * Provides the license model information for this DB cluster snapshot.
2750 */
2751 LicenseModel?: String;
2752 /**
2753 * Provides the type of the DB cluster snapshot.
2754 */
2755 SnapshotType?: String;
2756 /**
2757 * Specifies the percentage of the estimated data that has been transferred.
2758 */
2759 PercentProgress?: Integer;
2760 /**
2761 * Specifies whether the DB cluster snapshot is encrypted.
2762 */
2763 StorageEncrypted?: Boolean;
2764 /**
2765 * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
2766 */
2767 KmsKeyId?: String;
2768 /**
2769 * The Amazon Resource Name (ARN) for the DB cluster snapshot.
2770 */
2771 DBClusterSnapshotArn?: String;
2772 /**
2773 * 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.
2774 */
2775 SourceDBClusterSnapshotArn?: String;
2776 /**
2777 * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
2778 */
2779 IAMDatabaseAuthenticationEnabled?: Boolean;
2780 }
2781 export interface DBClusterSnapshotAttribute {
2782 /**
2783 * 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.
2784 */
2785 AttributeName?: String;
2786 /**
2787 * 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.
2788 */
2789 AttributeValues?: AttributeValueList;
2790 }
2791 export type DBClusterSnapshotAttributeList = DBClusterSnapshotAttribute[];
2792 export interface DBClusterSnapshotAttributesResult {
2793 /**
2794 * The identifier of the manual DB cluster snapshot that the attributes apply to.
2795 */
2796 DBClusterSnapshotIdentifier?: String;
2797 /**
2798 * The list of attributes and values for the manual DB cluster snapshot.
2799 */
2800 DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList;
2801 }
2802 export type DBClusterSnapshotList = DBClusterSnapshot[];
2803 export interface DBClusterSnapshotMessage {
2804 /**
2805 * 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.
2806 */
2807 Marker?: String;
2808 /**
2809 * Provides a list of DB cluster snapshots for the user.
2810 */
2811 DBClusterSnapshots?: DBClusterSnapshotList;
2812 }
2813 export interface DBEngineVersion {
2814 /**
2815 * The name of the database engine.
2816 */
2817 Engine?: String;
2818 /**
2819 * The version number of the database engine.
2820 */
2821 EngineVersion?: String;
2822 /**
2823 * The name of the DB parameter group family for the database engine.
2824 */
2825 DBParameterGroupFamily?: String;
2826 /**
2827 * The description of the database engine.
2828 */
2829 DBEngineDescription?: String;
2830 /**
2831 * The description of the database engine version.
2832 */
2833 DBEngineVersionDescription?: String;
2834 /**
2835 * The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
2836 */
2837 DefaultCharacterSet?: CharacterSet;
2838 /**
2839 * A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.
2840 */
2841 SupportedCharacterSets?: SupportedCharacterSetsList;
2842 /**
2843 * A list of engine versions that this database engine version can be upgraded to.
2844 */
2845 ValidUpgradeTarget?: ValidUpgradeTargetList;
2846 /**
2847 * A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
2848 */
2849 SupportedTimezones?: SupportedTimezonesList;
2850 /**
2851 * The types of logs that the database engine has available for export to CloudWatch Logs.
2852 */
2853 ExportableLogTypes?: LogTypeList;
2854 /**
2855 * A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
2856 */
2857 SupportsLogExportsToCloudwatchLogs?: Boolean;
2858 /**
2859 * Indicates whether the database engine version supports Read Replicas.
2860 */
2861 SupportsReadReplica?: Boolean;
2862 /**
2863 * A list of the supported DB engine modes.
2864 */
2865 SupportedEngineModes?: EngineModeList;
2866 /**
2867 * A list of features supported by the DB engine. Supported feature names include the following. s3Import
2868 */
2869 SupportedFeatureNames?: FeatureNameList;
2870 /**
2871 * The status of the DB engine version, either available or deprecated.
2872 */
2873 Status?: String;
2874 }
2875 export type DBEngineVersionList = DBEngineVersion[];
2876 export interface DBEngineVersionMessage {
2877 /**
2878 * 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.
2879 */
2880 Marker?: String;
2881 /**
2882 * A list of DBEngineVersion elements.
2883 */
2884 DBEngineVersions?: DBEngineVersionList;
2885 }
2886 export interface DBInstance {
2887 /**
2888 * Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
2889 */
2890 DBInstanceIdentifier?: String;
2891 /**
2892 * Contains the name of the compute and memory capacity class of the DB instance.
2893 */
2894 DBInstanceClass?: String;
2895 /**
2896 * Provides the name of the database engine to be used for this DB instance.
2897 */
2898 Engine?: String;
2899 /**
2900 * Specifies the current state of this database.
2901 */
2902 DBInstanceStatus?: String;
2903 /**
2904 * Contains the master username for the DB instance.
2905 */
2906 MasterUsername?: String;
2907 /**
2908 * The meaning of this parameter differs according to the database engine you use. 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.
2909 */
2910 DBName?: String;
2911 /**
2912 * Specifies the connection endpoint.
2913 */
2914 Endpoint?: Endpoint;
2915 /**
2916 * Specifies the allocated storage size specified in gibibytes.
2917 */
2918 AllocatedStorage?: Integer;
2919 /**
2920 * Provides the date and time the DB instance was created.
2921 */
2922 InstanceCreateTime?: TStamp;
2923 /**
2924 * Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
2925 */
2926 PreferredBackupWindow?: String;
2927 /**
2928 * Specifies the number of days for which automatic DB snapshots are retained.
2929 */
2930 BackupRetentionPeriod?: Integer;
2931 /**
2932 * A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
2933 */
2934 DBSecurityGroups?: DBSecurityGroupMembershipList;
2935 /**
2936 * Provides a list of VPC security group elements that the DB instance belongs to.
2937 */
2938 VpcSecurityGroups?: VpcSecurityGroupMembershipList;
2939 /**
2940 * Provides the list of DB parameter groups applied to this DB instance.
2941 */
2942 DBParameterGroups?: DBParameterGroupStatusList;
2943 /**
2944 * Specifies the name of the Availability Zone the DB instance is located in.
2945 */
2946 AvailabilityZone?: String;
2947 /**
2948 * Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
2949 */
2950 DBSubnetGroup?: DBSubnetGroup;
2951 /**
2952 * Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
2953 */
2954 PreferredMaintenanceWindow?: String;
2955 /**
2956 * Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
2957 */
2958 PendingModifiedValues?: PendingModifiedValues;
2959 /**
2960 * Specifies the latest time to which a database can be restored with point-in-time restore.
2961 */
2962 LatestRestorableTime?: TStamp;
2963 /**
2964 * Specifies if the DB instance is a Multi-AZ deployment.
2965 */
2966 MultiAZ?: Boolean;
2967 /**
2968 * Indicates the database engine version.
2969 */
2970 EngineVersion?: String;
2971 /**
2972 * Indicates that minor version patches are applied automatically.
2973 */
2974 AutoMinorVersionUpgrade?: Boolean;
2975 /**
2976 * Contains the identifier of the source DB instance if this DB instance is a Read Replica.
2977 */
2978 ReadReplicaSourceDBInstanceIdentifier?: String;
2979 /**
2980 * Contains one or more identifiers of the Read Replicas associated with this DB instance.
2981 */
2982 ReadReplicaDBInstanceIdentifiers?: ReadReplicaDBInstanceIdentifierList;
2983 /**
2984 * 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.
2985 */
2986 ReadReplicaDBClusterIdentifiers?: ReadReplicaDBClusterIdentifierList;
2987 /**
2988 * License model information for this DB instance.
2989 */
2990 LicenseModel?: String;
2991 /**
2992 * Specifies the Provisioned IOPS (I/O operations per second) value.
2993 */
2994 Iops?: IntegerOptional;
2995 /**
2996 * Provides the list of option group memberships for this DB instance.
2997 */
2998 OptionGroupMemberships?: OptionGroupMembershipList;
2999 /**
3000 * If present, specifies the name of the character set that this instance is associated with.
3001 */
3002 CharacterSetName?: String;
3003 /**
3004 * If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
3005 */
3006 SecondaryAvailabilityZone?: String;
3007 /**
3008 * 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.
3009 */
3010 PubliclyAccessible?: Boolean;
3011 /**
3012 * The status of a Read Replica. If the instance isn't a Read Replica, this is blank.
3013 */
3014 StatusInfos?: DBInstanceStatusInfoList;
3015 /**
3016 * Specifies the storage type associated with DB instance.
3017 */
3018 StorageType?: String;
3019 /**
3020 * The ARN from the key store with which the instance is associated for TDE encryption.
3021 */
3022 TdeCredentialArn?: String;
3023 /**
3024 * 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.
3025 */
3026 DbInstancePort?: Integer;
3027 /**
3028 * 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.
3029 */
3030 DBClusterIdentifier?: String;
3031 /**
3032 * Specifies whether the DB instance is encrypted.
3033 */
3034 StorageEncrypted?: Boolean;
3035 /**
3036 * If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
3037 */
3038 KmsKeyId?: String;
3039 /**
3040 * 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.
3041 */
3042 DbiResourceId?: String;
3043 /**
3044 * The identifier of the CA certificate for this DB instance.
3045 */
3046 CACertificateIdentifier?: String;
3047 /**
3048 * The Active Directory Domain membership records associated with the DB instance.
3049 */
3050 DomainMemberships?: DomainMembershipList;
3051 /**
3052 * 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.
3053 */
3054 CopyTagsToSnapshot?: Boolean;
3055 /**
3056 * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
3057 */
3058 MonitoringInterval?: IntegerOptional;
3059 /**
3060 * The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
3061 */
3062 EnhancedMonitoringResourceArn?: String;
3063 /**
3064 * The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
3065 */
3066 MonitoringRoleArn?: String;
3067 /**
3068 * 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.
3069 */
3070 PromotionTier?: IntegerOptional;
3071 /**
3072 * The Amazon Resource Name (ARN) for the DB instance.
3073 */
3074 DBInstanceArn?: String;
3075 /**
3076 * 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.
3077 */
3078 Timezone?: String;
3079 /**
3080 * 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.
3081 */
3082 IAMDatabaseAuthenticationEnabled?: Boolean;
3083 /**
3084 * True if Performance Insights is enabled for the DB instance, and otherwise false.
3085 */
3086 PerformanceInsightsEnabled?: BooleanOptional;
3087 /**
3088 * 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.
3089 */
3090 PerformanceInsightsKMSKeyId?: String;
3091 /**
3092 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
3093 */
3094 PerformanceInsightsRetentionPeriod?: IntegerOptional;
3095 /**
3096 * 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.
3097 */
3098 EnabledCloudwatchLogsExports?: LogTypeList;
3099 /**
3100 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
3101 */
3102 ProcessorFeatures?: ProcessorFeatureList;
3103 /**
3104 * Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
3105 */
3106 DeletionProtection?: Boolean;
3107 /**
3108 * The AWS Identity and Access Management (IAM) roles associated with the DB instance.
3109 */
3110 AssociatedRoles?: DBInstanceRoles;
3111 /**
3112 * Specifies the listener connection endpoint for SQL Server Always On.
3113 */
3114 ListenerEndpoint?: Endpoint;
3115 /**
3116 * The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
3117 */
3118 MaxAllocatedStorage?: IntegerOptional;
3119 }
3120 export interface DBInstanceAutomatedBackup {
3121 /**
3122 * The Amazon Resource Name (ARN) for the automated backup.
3123 */
3124 DBInstanceArn?: String;
3125 /**
3126 * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
3127 */
3128 DbiResourceId?: String;
3129 /**
3130 * The AWS Region associated with the automated backup.
3131 */
3132 Region?: String;
3133 /**
3134 * The customer id of the instance that is/was associated with the automated backup.
3135 */
3136 DBInstanceIdentifier?: String;
3137 /**
3138 * Earliest and latest time an instance can be restored to.
3139 */
3140 RestoreWindow?: RestoreWindow;
3141 /**
3142 * Specifies the allocated storage size in gibibytes (GiB).
3143 */
3144 AllocatedStorage?: Integer;
3145 /**
3146 * 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.
3147 */
3148 Status?: String;
3149 /**
3150 * The port number that the automated backup used for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535
3151 */
3152 Port?: Integer;
3153 /**
3154 * The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
3155 */
3156 AvailabilityZone?: String;
3157 /**
3158 * Provides the VPC ID associated with the DB instance
3159 */
3160 VpcId?: String;
3161 /**
3162 * Provides the date and time that the DB instance was created.
3163 */
3164 InstanceCreateTime?: TStamp;
3165 /**
3166 * The license model of an automated backup.
3167 */
3168 MasterUsername?: String;
3169 /**
3170 * The name of the database engine for this automated backup.
3171 */
3172 Engine?: String;
3173 /**
3174 * The version of the database engine for the automated backup.
3175 */
3176 EngineVersion?: String;
3177 /**
3178 * License model information for the automated backup.
3179 */
3180 LicenseModel?: String;
3181 /**
3182 * The IOPS (I/O operations per second) value for the automated backup.
3183 */
3184 Iops?: IntegerOptional;
3185 /**
3186 * The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
3187 */
3188 OptionGroupName?: String;
3189 /**
3190 * The ARN from the key store with which the automated backup is associated for TDE encryption.
3191 */
3192 TdeCredentialArn?: String;
3193 /**
3194 * Specifies whether the automated backup is encrypted.
3195 */
3196 Encrypted?: Boolean;
3197 /**
3198 * Specifies the storage type associated with the automated backup.
3199 */
3200 StorageType?: String;
3201 /**
3202 * 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.
3203 */
3204 KmsKeyId?: String;
3205 /**
3206 * 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.
3207 */
3208 Timezone?: String;
3209 /**
3210 * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
3211 */
3212 IAMDatabaseAuthenticationEnabled?: Boolean;
3213 }
3214 export type DBInstanceAutomatedBackupList = DBInstanceAutomatedBackup[];
3215 export interface DBInstanceAutomatedBackupMessage {
3216 /**
3217 * 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 .
3218 */
3219 Marker?: String;
3220 /**
3221 * A list of DBInstanceAutomatedBackup instances.
3222 */
3223 DBInstanceAutomatedBackups?: DBInstanceAutomatedBackupList;
3224 }
3225 export type DBInstanceList = DBInstance[];
3226 export interface DBInstanceMessage {
3227 /**
3228 * 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 .
3229 */
3230 Marker?: String;
3231 /**
3232 * A list of DBInstance instances.
3233 */
3234 DBInstances?: DBInstanceList;
3235 }
3236 export interface DBInstanceRole {
3237 /**
3238 * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
3239 */
3240 RoleArn?: String;
3241 /**
3242 * The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.
3243 */
3244 FeatureName?: String;
3245 /**
3246 * 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.
3247 */
3248 Status?: String;
3249 }
3250 export type DBInstanceRoles = DBInstanceRole[];
3251 export interface DBInstanceStatusInfo {
3252 /**
3253 * This value is currently "read replication."
3254 */
3255 StatusType?: String;
3256 /**
3257 * Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
3258 */
3259 Normal?: Boolean;
3260 /**
3261 * 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.
3262 */
3263 Status?: String;
3264 /**
3265 * Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
3266 */
3267 Message?: String;
3268 }
3269 export type DBInstanceStatusInfoList = DBInstanceStatusInfo[];
3270 export interface DBParameterGroup {
3271 /**
3272 * Provides the name of the DB parameter group.
3273 */
3274 DBParameterGroupName?: String;
3275 /**
3276 * Provides the name of the DB parameter group family that this DB parameter group is compatible with.
3277 */
3278 DBParameterGroupFamily?: String;
3279 /**
3280 * Provides the customer-specified description for this DB parameter group.
3281 */
3282 Description?: String;
3283 /**
3284 * The Amazon Resource Name (ARN) for the DB parameter group.
3285 */
3286 DBParameterGroupArn?: String;
3287 }
3288 export interface DBParameterGroupDetails {
3289 /**
3290 * A list of Parameter values.
3291 */
3292 Parameters?: ParametersList;
3293 /**
3294 * 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.
3295 */
3296 Marker?: String;
3297 }
3298 export type DBParameterGroupList = DBParameterGroup[];
3299 export interface DBParameterGroupNameMessage {
3300 /**
3301 * Provides the name of the DB parameter group.
3302 */
3303 DBParameterGroupName?: String;
3304 }
3305 export interface DBParameterGroupStatus {
3306 /**
3307 * The name of the DB parameter group.
3308 */
3309 DBParameterGroupName?: String;
3310 /**
3311 * The status of parameter updates.
3312 */
3313 ParameterApplyStatus?: String;
3314 }
3315 export type DBParameterGroupStatusList = DBParameterGroupStatus[];
3316 export interface DBParameterGroupsMessage {
3317 /**
3318 * 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.
3319 */
3320 Marker?: String;
3321 /**
3322 * A list of DBParameterGroup instances.
3323 */
3324 DBParameterGroups?: DBParameterGroupList;
3325 }
3326 export interface DBProxy {
3327 /**
3328 * The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
3329 */
3330 DBProxyName?: String;
3331 /**
3332 * The Amazon Resource Name (ARN) for the proxy.
3333 */
3334 DBProxyArn?: String;
3335 /**
3336 * The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
3337 */
3338 Status?: DBProxyStatus;
3339 /**
3340 * Currently, this value is always MYSQL. The engine family applies to both RDS MySQL and Aurora MySQL.
3341 */
3342 EngineFamily?: String;
3343 /**
3344 * Provides a list of VPC security groups that the proxy belongs to.
3345 */
3346 VpcSecurityGroupIds?: StringList;
3347 /**
3348 * The EC2 subnet IDs for the proxy.
3349 */
3350 VpcSubnetIds?: StringList;
3351 /**
3352 * One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
3353 */
3354 Auth?: UserAuthConfigInfoList;
3355 /**
3356 * The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
3357 */
3358 RoleArn?: String;
3359 /**
3360 * The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
3361 */
3362 Endpoint?: String;
3363 /**
3364 * Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
3365 */
3366 RequireTLS?: Boolean;
3367 /**
3368 * The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800
3369 */
3370 IdleClientTimeout?: Integer;
3371 /**
3372 * Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
3373 */
3374 DebugLogging?: Boolean;
3375 /**
3376 * The date and time when the proxy was first created.
3377 */
3378 CreatedDate?: TStamp;
3379 /**
3380 * The date and time when the proxy was last updated.
3381 */
3382 UpdatedDate?: TStamp;
3383 }
3384 export type DBProxyList = DBProxy[];
3385 export type DBProxyStatus = "available"|"modifying"|"incompatible-network"|"insufficient-resource-limits"|"creating"|"deleting"|string;
3386 export interface DBProxyTarget {
3387 /**
3388 * The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
3389 */
3390 TargetArn?: String;
3391 /**
3392 * The writer endpoint for the RDS DB instance or Aurora DB cluster.
3393 */
3394 Endpoint?: String;
3395 /**
3396 * The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
3397 */
3398 TrackedClusterId?: String;
3399 /**
3400 * The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
3401 */
3402 RdsResourceId?: String;
3403 /**
3404 * The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
3405 */
3406 Port?: Integer;
3407 /**
3408 * Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
3409 */
3410 Type?: TargetType;
3411 }
3412 export interface DBProxyTargetGroup {
3413 /**
3414 * The identifier for the RDS proxy associated with this target group.
3415 */
3416 DBProxyName?: String;
3417 /**
3418 * The identifier for the target group. This name must be unique for all target groups owned by your AWS account in the specified AWS Region.
3419 */
3420 TargetGroupName?: String;
3421 /**
3422 * The Amazon Resource Name (ARN) representing the target group.
3423 */
3424 TargetGroupArn?: String;
3425 /**
3426 * Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.
3427 */
3428 IsDefault?: Boolean;
3429 /**
3430 * The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.
3431 */
3432 Status?: String;
3433 /**
3434 * The settings that determine the size and behavior of the connection pool for the target group.
3435 */
3436 ConnectionPoolConfig?: ConnectionPoolConfigurationInfo;
3437 /**
3438 * The date and time when the target group was first created.
3439 */
3440 CreatedDate?: TStamp;
3441 /**
3442 * The date and time when the target group was last updated.
3443 */
3444 UpdatedDate?: TStamp;
3445 }
3446 export interface DBSecurityGroup {
3447 /**
3448 * Provides the AWS ID of the owner of a specific DB security group.
3449 */
3450 OwnerId?: String;
3451 /**
3452 * Specifies the name of the DB security group.
3453 */
3454 DBSecurityGroupName?: String;
3455 /**
3456 * Provides the description of the DB security group.
3457 */
3458 DBSecurityGroupDescription?: String;
3459 /**
3460 * Provides the VpcId of the DB security group.
3461 */
3462 VpcId?: String;
3463 /**
3464 * Contains a list of EC2SecurityGroup elements.
3465 */
3466 EC2SecurityGroups?: EC2SecurityGroupList;
3467 /**
3468 * Contains a list of IPRange elements.
3469 */
3470 IPRanges?: IPRangeList;
3471 /**
3472 * The Amazon Resource Name (ARN) for the DB security group.
3473 */
3474 DBSecurityGroupArn?: String;
3475 }
3476 export interface DBSecurityGroupMembership {
3477 /**
3478 * The name of the DB security group.
3479 */
3480 DBSecurityGroupName?: String;
3481 /**
3482 * The status of the DB security group.
3483 */
3484 Status?: String;
3485 }
3486 export type DBSecurityGroupMembershipList = DBSecurityGroupMembership[];
3487 export interface DBSecurityGroupMessage {
3488 /**
3489 * 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.
3490 */
3491 Marker?: String;
3492 /**
3493 * A list of DBSecurityGroup instances.
3494 */
3495 DBSecurityGroups?: DBSecurityGroups;
3496 }
3497 export type DBSecurityGroupNameList = String[];
3498 export type DBSecurityGroups = DBSecurityGroup[];
3499 export interface DBSnapshot {
3500 /**
3501 * Specifies the identifier for the DB snapshot.
3502 */
3503 DBSnapshotIdentifier?: String;
3504 /**
3505 * Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
3506 */
3507 DBInstanceIdentifier?: String;
3508 /**
3509 * Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
3510 */
3511 SnapshotCreateTime?: TStamp;
3512 /**
3513 * Specifies the name of the database engine.
3514 */
3515 Engine?: String;
3516 /**
3517 * Specifies the allocated storage size in gibibytes (GiB).
3518 */
3519 AllocatedStorage?: Integer;
3520 /**
3521 * Specifies the status of this DB snapshot.
3522 */
3523 Status?: String;
3524 /**
3525 * Specifies the port that the database engine was listening on at the time of the snapshot.
3526 */
3527 Port?: Integer;
3528 /**
3529 * Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
3530 */
3531 AvailabilityZone?: String;
3532 /**
3533 * Provides the VPC ID associated with the DB snapshot.
3534 */
3535 VpcId?: String;
3536 /**
3537 * Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
3538 */
3539 InstanceCreateTime?: TStamp;
3540 /**
3541 * Provides the master username for the DB snapshot.
3542 */
3543 MasterUsername?: String;
3544 /**
3545 * Specifies the version of the database engine.
3546 */
3547 EngineVersion?: String;
3548 /**
3549 * License model information for the restored DB instance.
3550 */
3551 LicenseModel?: String;
3552 /**
3553 * Provides the type of the DB snapshot.
3554 */
3555 SnapshotType?: String;
3556 /**
3557 * Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
3558 */
3559 Iops?: IntegerOptional;
3560 /**
3561 * Provides the option group name for the DB snapshot.
3562 */
3563 OptionGroupName?: String;
3564 /**
3565 * The percentage of the estimated data that has been transferred.
3566 */
3567 PercentProgress?: Integer;
3568 /**
3569 * The AWS Region that the DB snapshot was created in or copied from.
3570 */
3571 SourceRegion?: String;
3572 /**
3573 * 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.
3574 */
3575 SourceDBSnapshotIdentifier?: String;
3576 /**
3577 * Specifies the storage type associated with DB snapshot.
3578 */
3579 StorageType?: String;
3580 /**
3581 * The ARN from the key store with which to associate the instance for TDE encryption.
3582 */
3583 TdeCredentialArn?: String;
3584 /**
3585 * Specifies whether the DB snapshot is encrypted.
3586 */
3587 Encrypted?: Boolean;
3588 /**
3589 * If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
3590 */
3591 KmsKeyId?: String;
3592 /**
3593 * The Amazon Resource Name (ARN) for the DB snapshot.
3594 */
3595 DBSnapshotArn?: String;
3596 /**
3597 * 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.
3598 */
3599 Timezone?: String;
3600 /**
3601 * True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
3602 */
3603 IAMDatabaseAuthenticationEnabled?: Boolean;
3604 /**
3605 * 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.
3606 */
3607 ProcessorFeatures?: ProcessorFeatureList;
3608 /**
3609 * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
3610 */
3611 DbiResourceId?: String;
3612 }
3613 export interface DBSnapshotAttribute {
3614 /**
3615 * 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.
3616 */
3617 AttributeName?: String;
3618 /**
3619 * 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.
3620 */
3621 AttributeValues?: AttributeValueList;
3622 }
3623 export type DBSnapshotAttributeList = DBSnapshotAttribute[];
3624 export interface DBSnapshotAttributesResult {
3625 /**
3626 * The identifier of the manual DB snapshot that the attributes apply to.
3627 */
3628 DBSnapshotIdentifier?: String;
3629 /**
3630 * The list of attributes and values for the manual DB snapshot.
3631 */
3632 DBSnapshotAttributes?: DBSnapshotAttributeList;
3633 }
3634 export type DBSnapshotList = DBSnapshot[];
3635 export interface DBSnapshotMessage {
3636 /**
3637 * 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.
3638 */
3639 Marker?: String;
3640 /**
3641 * A list of DBSnapshot instances.
3642 */
3643 DBSnapshots?: DBSnapshotList;
3644 }
3645 export interface DBSubnetGroup {
3646 /**
3647 * The name of the DB subnet group.
3648 */
3649 DBSubnetGroupName?: String;
3650 /**
3651 * Provides the description of the DB subnet group.
3652 */
3653 DBSubnetGroupDescription?: String;
3654 /**
3655 * Provides the VpcId of the DB subnet group.
3656 */
3657 VpcId?: String;
3658 /**
3659 * Provides the status of the DB subnet group.
3660 */
3661 SubnetGroupStatus?: String;
3662 /**
3663 * Contains a list of Subnet elements.
3664 */
3665 Subnets?: SubnetList;
3666 /**
3667 * The Amazon Resource Name (ARN) for the DB subnet group.
3668 */
3669 DBSubnetGroupArn?: String;
3670 }
3671 export interface DBSubnetGroupMessage {
3672 /**
3673 * 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.
3674 */
3675 Marker?: String;
3676 /**
3677 * A list of DBSubnetGroup instances.
3678 */
3679 DBSubnetGroups?: DBSubnetGroups;
3680 }
3681 export type DBSubnetGroups = DBSubnetGroup[];
3682 export interface DeleteCustomAvailabilityZoneMessage {
3683 /**
3684 * The custom AZ identifier.
3685 */
3686 CustomAvailabilityZoneId: String;
3687 }
3688 export interface DeleteCustomAvailabilityZoneResult {
3689 CustomAvailabilityZone?: CustomAvailabilityZone;
3690 }
3691 export interface DeleteDBClusterEndpointMessage {
3692 /**
3693 * The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
3694 */
3695 DBClusterEndpointIdentifier: String;
3696 }
3697 export interface DeleteDBClusterMessage {
3698 /**
3699 * The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: Must match an existing DBClusterIdentifier.
3700 */
3701 DBClusterIdentifier: String;
3702 /**
3703 * A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled. You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
3704 */
3705 SkipFinalSnapshot?: Boolean;
3706 /**
3707 * The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled. Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter 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
3708 */
3709 FinalDBSnapshotIdentifier?: String;
3710 }
3711 export interface DeleteDBClusterParameterGroupMessage {
3712 /**
3713 * 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.
3714 */
3715 DBClusterParameterGroupName: String;
3716 }
3717 export interface DeleteDBClusterResult {
3718 DBCluster?: DBCluster;
3719 }
3720 export interface DeleteDBClusterSnapshotMessage {
3721 /**
3722 * The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state.
3723 */
3724 DBClusterSnapshotIdentifier: String;
3725 }
3726 export interface DeleteDBClusterSnapshotResult {
3727 DBClusterSnapshot?: DBClusterSnapshot;
3728 }
3729 export interface DeleteDBInstanceAutomatedBackupMessage {
3730 /**
3731 * The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
3732 */
3733 DbiResourceId: String;
3734 }
3735 export interface DeleteDBInstanceAutomatedBackupResult {
3736 DBInstanceAutomatedBackup?: DBInstanceAutomatedBackup;
3737 }
3738 export interface DeleteDBInstanceMessage {
3739 /**
3740 * 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.
3741 */
3742 DBInstanceIdentifier: String;
3743 /**
3744 * A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created. When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified. Specify skip when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
3745 */
3746 SkipFinalSnapshot?: Boolean;
3747 /**
3748 * The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled. Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot 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.
3749 */
3750 FinalDBSnapshotIdentifier?: String;
3751 /**
3752 * A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
3753 */
3754 DeleteAutomatedBackups?: BooleanOptional;
3755 }
3756 export interface DeleteDBInstanceResult {
3757 DBInstance?: DBInstance;
3758 }
3759 export interface DeleteDBParameterGroupMessage {
3760 /**
3761 * 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
3762 */
3763 DBParameterGroupName: String;
3764 }
3765 export interface DeleteDBProxyRequest {
3766 /**
3767 * The name of the DB proxy to delete.
3768 */
3769 DBProxyName: String;
3770 }
3771 export interface DeleteDBProxyResponse {
3772 /**
3773 * The data structure representing the details of the DB proxy that you delete.
3774 */
3775 DBProxy?: DBProxy;
3776 }
3777 export interface DeleteDBSecurityGroupMessage {
3778 /**
3779 * 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"
3780 */
3781 DBSecurityGroupName: String;
3782 }
3783 export interface DeleteDBSnapshotMessage {
3784 /**
3785 * The DB snapshot identifier. Constraints: Must be the name of an existing DB snapshot in the available state.
3786 */
3787 DBSnapshotIdentifier: String;
3788 }
3789 export interface DeleteDBSnapshotResult {
3790 DBSnapshot?: DBSnapshot;
3791 }
3792 export interface DeleteDBSubnetGroupMessage {
3793 /**
3794 * 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
3795 */
3796 DBSubnetGroupName: String;
3797 }
3798 export interface DeleteEventSubscriptionMessage {
3799 /**
3800 * The name of the RDS event notification subscription you want to delete.
3801 */
3802 SubscriptionName: String;
3803 }
3804 export interface DeleteEventSubscriptionResult {
3805 EventSubscription?: EventSubscription;
3806 }
3807 export interface DeleteGlobalClusterMessage {
3808 /**
3809 * The cluster identifier of the global database cluster being deleted.
3810 */
3811 GlobalClusterIdentifier: String;
3812 }
3813 export interface DeleteGlobalClusterResult {
3814 GlobalCluster?: GlobalCluster;
3815 }
3816 export interface DeleteInstallationMediaMessage {
3817 /**
3818 * The installation medium ID.
3819 */
3820 InstallationMediaId: String;
3821 }
3822 export interface DeleteOptionGroupMessage {
3823 /**
3824 * The name of the option group to be deleted. You can't delete default option groups.
3825 */
3826 OptionGroupName: String;
3827 }
3828 export interface DeregisterDBProxyTargetsRequest {
3829 /**
3830 * The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
3831 */
3832 DBProxyName: String;
3833 /**
3834 * The identifier of the DBProxyTargetGroup.
3835 */
3836 TargetGroupName?: String;
3837 /**
3838 * One or more DB instance identifiers.
3839 */
3840 DBInstanceIdentifiers?: StringList;
3841 /**
3842 * One or more DB cluster identifiers.
3843 */
3844 DBClusterIdentifiers?: StringList;
3845 }
3846 export interface DeregisterDBProxyTargetsResponse {
3847 }
3848 export interface DescribeAccountAttributesMessage {
3849 }
3850 export interface DescribeCertificatesMessage {
3851 /**
3852 * 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.
3853 */
3854 CertificateIdentifier?: String;
3855 /**
3856 * This parameter isn't currently supported.
3857 */
3858 Filters?: FilterList;
3859 /**
3860 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
3861 */
3862 MaxRecords?: IntegerOptional;
3863 /**
3864 * 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.
3865 */
3866 Marker?: String;
3867 }
3868 export interface DescribeCustomAvailabilityZonesMessage {
3869 /**
3870 * The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.
3871 */
3872 CustomAvailabilityZoneId?: String;
3873 /**
3874 * A filter that specifies one or more custom AZs to describe.
3875 */
3876 Filters?: FilterList;
3877 /**
3878 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
3879 */
3880 MaxRecords?: IntegerOptional;
3881 /**
3882 * An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
3883 */
3884 Marker?: String;
3885 }
3886 export interface DescribeDBClusterBacktracksMessage {
3887 /**
3888 * 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
3889 */
3890 DBClusterIdentifier: String;
3891 /**
3892 * 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
3893 */
3894 BacktrackIdentifier?: String;
3895 /**
3896 * 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.
3897 */
3898 Filters?: FilterList;
3899 /**
3900 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
3901 */
3902 MaxRecords?: IntegerOptional;
3903 /**
3904 * 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.
3905 */
3906 Marker?: String;
3907 }
3908 export interface DescribeDBClusterEndpointsMessage {
3909 /**
3910 * The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
3911 */
3912 DBClusterIdentifier?: String;
3913 /**
3914 * The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
3915 */
3916 DBClusterEndpointIdentifier?: String;
3917 /**
3918 * 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.
3919 */
3920 Filters?: FilterList;
3921 /**
3922 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
3923 */
3924 MaxRecords?: IntegerOptional;
3925 /**
3926 * 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.
3927 */
3928 Marker?: String;
3929 }
3930 export interface DescribeDBClusterParameterGroupsMessage {
3931 /**
3932 * The name of a specific DB cluster parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
3933 */
3934 DBClusterParameterGroupName?: String;
3935 /**
3936 * This parameter isn't currently supported.
3937 */
3938 Filters?: FilterList;
3939 /**
3940 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
3941 */
3942 MaxRecords?: IntegerOptional;
3943 /**
3944 * 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.
3945 */
3946 Marker?: String;
3947 }
3948 export interface DescribeDBClusterParametersMessage {
3949 /**
3950 * 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.
3951 */
3952 DBClusterParameterGroupName: String;
3953 /**
3954 * A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
3955 */
3956 Source?: String;
3957 /**
3958 * This parameter isn't currently supported.
3959 */
3960 Filters?: FilterList;
3961 /**
3962 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
3963 */
3964 MaxRecords?: IntegerOptional;
3965 /**
3966 * 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.
3967 */
3968 Marker?: String;
3969 }
3970 export interface DescribeDBClusterSnapshotAttributesMessage {
3971 /**
3972 * The identifier for the DB cluster snapshot to describe the attributes for.
3973 */
3974 DBClusterSnapshotIdentifier: String;
3975 }
3976 export interface DescribeDBClusterSnapshotAttributesResult {
3977 DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
3978 }
3979 export interface DescribeDBClusterSnapshotsMessage {
3980 /**
3981 * 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 isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster.
3982 */
3983 DBClusterIdentifier?: String;
3984 /**
3985 * 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.
3986 */
3987 DBClusterSnapshotIdentifier?: String;
3988 /**
3989 * 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 enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter. 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.
3990 */
3991 SnapshotType?: String;
3992 /**
3993 * A filter that specifies one or more DB cluster snapshots to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers. snapshot-type - Accepts types of DB cluster snapshots. engine - Accepts names of database engines.
3994 */
3995 Filters?: FilterList;
3996 /**
3997 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
3998 */
3999 MaxRecords?: IntegerOptional;
4000 /**
4001 * 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.
4002 */
4003 Marker?: String;
4004 /**
4005 * A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included. You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
4006 */
4007 IncludeShared?: Boolean;
4008 /**
4009 * A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
4010 */
4011 IncludePublic?: Boolean;
4012 }
4013 export interface DescribeDBClustersMessage {
4014 /**
4015 * 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.
4016 */
4017 DBClusterIdentifier?: String;
4018 /**
4019 * 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.
4020 */
4021 Filters?: FilterList;
4022 /**
4023 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4024 */
4025 MaxRecords?: IntegerOptional;
4026 /**
4027 * 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.
4028 */
4029 Marker?: String;
4030 /**
4031 * Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.
4032 */
4033 IncludeShared?: Boolean;
4034 }
4035 export interface DescribeDBEngineVersionsMessage {
4036 /**
4037 * The database engine to return.
4038 */
4039 Engine?: String;
4040 /**
4041 * The database engine version to return. Example: 5.1.49
4042 */
4043 EngineVersion?: String;
4044 /**
4045 * The name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DBParameterGroupFamily.
4046 */
4047 DBParameterGroupFamily?: String;
4048 /**
4049 * This parameter isn't currently supported.
4050 */
4051 Filters?: FilterList;
4052 /**
4053 * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4054 */
4055 MaxRecords?: IntegerOptional;
4056 /**
4057 * 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.
4058 */
4059 Marker?: String;
4060 /**
4061 * A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
4062 */
4063 DefaultOnly?: Boolean;
4064 /**
4065 * A value that indicates whether to list the supported character sets for each engine version. If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
4066 */
4067 ListSupportedCharacterSets?: BooleanOptional;
4068 /**
4069 * A value that indicates whether to list the supported time zones for each engine version. If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
4070 */
4071 ListSupportedTimezones?: BooleanOptional;
4072 /**
4073 * A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
4074 */
4075 IncludeAll?: BooleanOptional;
4076 }
4077 export interface DescribeDBInstanceAutomatedBackupsMessage {
4078 /**
4079 * The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
4080 */
4081 DbiResourceId?: String;
4082 /**
4083 * (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.
4084 */
4085 DBInstanceIdentifier?: String;
4086 /**
4087 * 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.
4088 */
4089 Filters?: FilterList;
4090 /**
4091 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
4092 */
4093 MaxRecords?: IntegerOptional;
4094 /**
4095 * The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
4096 */
4097 Marker?: String;
4098 }
4099 export interface DescribeDBInstancesMessage {
4100 /**
4101 * 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.
4102 */
4103 DBInstanceIdentifier?: String;
4104 /**
4105 * 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. dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers. domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains. engine - Accepts engine names. The results list will only include information about the DB instances for these engines.
4106 */
4107 Filters?: FilterList;
4108 /**
4109 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4110 */
4111 MaxRecords?: IntegerOptional;
4112 /**
4113 * 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.
4114 */
4115 Marker?: String;
4116 }
4117 export interface DescribeDBLogFilesDetails {
4118 /**
4119 * The name of the log file for the specified DB instance.
4120 */
4121 LogFileName?: String;
4122 /**
4123 * A POSIX timestamp when the last log entry was written.
4124 */
4125 LastWritten?: Long;
4126 /**
4127 * The size, in bytes, of the log file for the specified DB instance.
4128 */
4129 Size?: Long;
4130 }
4131 export type DescribeDBLogFilesList = DescribeDBLogFilesDetails[];
4132 export interface DescribeDBLogFilesMessage {
4133 /**
4134 * 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.
4135 */
4136 DBInstanceIdentifier: String;
4137 /**
4138 * Filters the available log files for log file names that contain the specified string.
4139 */
4140 FilenameContains?: String;
4141 /**
4142 * Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
4143 */
4144 FileLastWritten?: Long;
4145 /**
4146 * Filters the available log files for files larger than the specified size.
4147 */
4148 FileSize?: Long;
4149 /**
4150 * This parameter isn't currently supported.
4151 */
4152 Filters?: FilterList;
4153 /**
4154 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
4155 */
4156 MaxRecords?: IntegerOptional;
4157 /**
4158 * The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
4159 */
4160 Marker?: String;
4161 }
4162 export interface DescribeDBLogFilesResponse {
4163 /**
4164 * The DB log files returned.
4165 */
4166 DescribeDBLogFiles?: DescribeDBLogFilesList;
4167 /**
4168 * A pagination token that can be used in a later DescribeDBLogFiles request.
4169 */
4170 Marker?: String;
4171 }
4172 export interface DescribeDBParameterGroupsMessage {
4173 /**
4174 * The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
4175 */
4176 DBParameterGroupName?: String;
4177 /**
4178 * This parameter isn't currently supported.
4179 */
4180 Filters?: FilterList;
4181 /**
4182 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4183 */
4184 MaxRecords?: IntegerOptional;
4185 /**
4186 * 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.
4187 */
4188 Marker?: String;
4189 }
4190 export interface DescribeDBParametersMessage {
4191 /**
4192 * The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBParameterGroup.
4193 */
4194 DBParameterGroupName: String;
4195 /**
4196 * The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default
4197 */
4198 Source?: String;
4199 /**
4200 * This parameter isn't currently supported.
4201 */
4202 Filters?: FilterList;
4203 /**
4204 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4205 */
4206 MaxRecords?: IntegerOptional;
4207 /**
4208 * 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.
4209 */
4210 Marker?: String;
4211 }
4212 export interface DescribeDBProxiesRequest {
4213 /**
4214 * The name of the DB proxy.
4215 */
4216 DBProxyName?: String;
4217 /**
4218 * This parameter is not currently supported.
4219 */
4220 Filters?: FilterList;
4221 /**
4222 * 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.
4223 */
4224 Marker?: String;
4225 /**
4226 * 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.
4227 */
4228 MaxRecords?: MaxRecords;
4229 }
4230 export interface DescribeDBProxiesResponse {
4231 /**
4232 * A return value representing an arbitrary number of DBProxy data structures.
4233 */
4234 DBProxies?: DBProxyList;
4235 /**
4236 * 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.
4237 */
4238 Marker?: String;
4239 }
4240 export interface DescribeDBProxyTargetGroupsRequest {
4241 /**
4242 * The identifier of the DBProxy associated with the target group.
4243 */
4244 DBProxyName: String;
4245 /**
4246 * The identifier of the DBProxyTargetGroup to describe.
4247 */
4248 TargetGroupName?: String;
4249 /**
4250 * This parameter is not currently supported.
4251 */
4252 Filters?: FilterList;
4253 /**
4254 * 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.
4255 */
4256 Marker?: String;
4257 /**
4258 * 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.
4259 */
4260 MaxRecords?: MaxRecords;
4261 }
4262 export interface DescribeDBProxyTargetGroupsResponse {
4263 /**
4264 * An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.
4265 */
4266 TargetGroups?: TargetGroupList;
4267 /**
4268 * 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.
4269 */
4270 Marker?: String;
4271 }
4272 export interface DescribeDBProxyTargetsRequest {
4273 /**
4274 * The identifier of the DBProxyTarget to describe.
4275 */
4276 DBProxyName: String;
4277 /**
4278 * The identifier of the DBProxyTargetGroup to describe.
4279 */
4280 TargetGroupName?: String;
4281 /**
4282 * This parameter is not currently supported.
4283 */
4284 Filters?: FilterList;
4285 /**
4286 * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
4287 */
4288 Marker?: String;
4289 /**
4290 * 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.
4291 */
4292 MaxRecords?: MaxRecords;
4293 }
4294 export interface DescribeDBProxyTargetsResponse {
4295 /**
4296 * An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
4297 */
4298 Targets?: TargetList;
4299 /**
4300 * 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.
4301 */
4302 Marker?: String;
4303 }
4304 export interface DescribeDBSecurityGroupsMessage {
4305 /**
4306 * The name of the DB security group to return details for.
4307 */
4308 DBSecurityGroupName?: String;
4309 /**
4310 * This parameter isn't currently supported.
4311 */
4312 Filters?: FilterList;
4313 /**
4314 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4315 */
4316 MaxRecords?: IntegerOptional;
4317 /**
4318 * 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.
4319 */
4320 Marker?: String;
4321 }
4322 export interface DescribeDBSnapshotAttributesMessage {
4323 /**
4324 * The identifier for the DB snapshot to describe the attributes for.
4325 */
4326 DBSnapshotIdentifier: String;
4327 }
4328 export interface DescribeDBSnapshotAttributesResult {
4329 DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
4330 }
4331 export interface DescribeDBSnapshotsMessage {
4332 /**
4333 * 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 isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance.
4334 */
4335 DBInstanceIdentifier?: String;
4336 /**
4337 * 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.
4338 */
4339 DBSnapshotIdentifier?: String;
4340 /**
4341 * 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 enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter. 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.
4342 */
4343 SnapshotType?: String;
4344 /**
4345 * A filter that specifies one or more DB snapshots to describe. Supported filters: db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). db-snapshot-id - Accepts DB snapshot identifiers. dbi-resource-id - Accepts identifiers of source DB instances. snapshot-type - Accepts types of DB snapshots. engine - Accepts names of database engines.
4346 */
4347 Filters?: FilterList;
4348 /**
4349 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4350 */
4351 MaxRecords?: IntegerOptional;
4352 /**
4353 * 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.
4354 */
4355 Marker?: String;
4356 /**
4357 * A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included. You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
4358 */
4359 IncludeShared?: Boolean;
4360 /**
4361 * A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
4362 */
4363 IncludePublic?: Boolean;
4364 /**
4365 * A specific DB resource ID to describe.
4366 */
4367 DbiResourceId?: String;
4368 }
4369 export interface DescribeDBSubnetGroupsMessage {
4370 /**
4371 * The name of the DB subnet group to return details for.
4372 */
4373 DBSubnetGroupName?: String;
4374 /**
4375 * This parameter isn't currently supported.
4376 */
4377 Filters?: FilterList;
4378 /**
4379 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4380 */
4381 MaxRecords?: IntegerOptional;
4382 /**
4383 * 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.
4384 */
4385 Marker?: String;
4386 }
4387 export interface DescribeEngineDefaultClusterParametersMessage {
4388 /**
4389 * The name of the DB cluster parameter group family to return engine parameter information for.
4390 */
4391 DBParameterGroupFamily: String;
4392 /**
4393 * This parameter isn't currently supported.
4394 */
4395 Filters?: FilterList;
4396 /**
4397 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4398 */
4399 MaxRecords?: IntegerOptional;
4400 /**
4401 * 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.
4402 */
4403 Marker?: String;
4404 }
4405 export interface DescribeEngineDefaultClusterParametersResult {
4406 EngineDefaults?: EngineDefaults;
4407 }
4408 export interface DescribeEngineDefaultParametersMessage {
4409 /**
4410 * The name of the DB parameter group family.
4411 */
4412 DBParameterGroupFamily: String;
4413 /**
4414 * This parameter isn't currently supported.
4415 */
4416 Filters?: FilterList;
4417 /**
4418 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4419 */
4420 MaxRecords?: IntegerOptional;
4421 /**
4422 * 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.
4423 */
4424 Marker?: String;
4425 }
4426 export interface DescribeEngineDefaultParametersResult {
4427 EngineDefaults?: EngineDefaults;
4428 }
4429 export interface DescribeEventCategoriesMessage {
4430 /**
4431 * The type of source that is generating the events. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
4432 */
4433 SourceType?: String;
4434 /**
4435 * This parameter isn't currently supported.
4436 */
4437 Filters?: FilterList;
4438 }
4439 export interface DescribeEventSubscriptionsMessage {
4440 /**
4441 * The name of the RDS event notification subscription you want to describe.
4442 */
4443 SubscriptionName?: String;
4444 /**
4445 * This parameter isn't currently supported.
4446 */
4447 Filters?: FilterList;
4448 /**
4449 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4450 */
4451 MaxRecords?: IntegerOptional;
4452 /**
4453 * 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 .
4454 */
4455 Marker?: String;
4456 }
4457 export interface DescribeEventsMessage {
4458 /**
4459 * 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.
4460 */
4461 SourceIdentifier?: String;
4462 /**
4463 * The event source to retrieve events for. If no value is specified, all events are returned.
4464 */
4465 SourceType?: SourceType;
4466 /**
4467 * 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
4468 */
4469 StartTime?: TStamp;
4470 /**
4471 * 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
4472 */
4473 EndTime?: TStamp;
4474 /**
4475 * The number of minutes to retrieve events for. Default: 60
4476 */
4477 Duration?: IntegerOptional;
4478 /**
4479 * A list of event categories that trigger notifications for a event notification subscription.
4480 */
4481 EventCategories?: EventCategoriesList;
4482 /**
4483 * This parameter isn't currently supported.
4484 */
4485 Filters?: FilterList;
4486 /**
4487 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4488 */
4489 MaxRecords?: IntegerOptional;
4490 /**
4491 * 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.
4492 */
4493 Marker?: String;
4494 }
4495 export interface DescribeExportTasksMessage {
4496 /**
4497 * The identifier of the snapshot export task to be described.
4498 */
4499 ExportTaskIdentifier?: String;
4500 /**
4501 * The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
4502 */
4503 SourceArn?: String;
4504 /**
4505 * Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Supported filters include the following: export-task-identifier - An identifier for the snapshot export task. s3-bucket - The Amazon S3 bucket the snapshot is exported to. source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3 status - The status of the export task.
4506 */
4507 Filters?: FilterList;
4508 /**
4509 * An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
4510 */
4511 Marker?: String;
4512 /**
4513 * The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4514 */
4515 MaxRecords?: MaxRecords;
4516 }
4517 export interface DescribeGlobalClustersMessage {
4518 /**
4519 * 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.
4520 */
4521 GlobalClusterIdentifier?: String;
4522 /**
4523 * 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.
4524 */
4525 Filters?: FilterList;
4526 /**
4527 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4528 */
4529 MaxRecords?: IntegerOptional;
4530 /**
4531 * 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.
4532 */
4533 Marker?: String;
4534 }
4535 export interface DescribeInstallationMediaMessage {
4536 /**
4537 * The installation medium ID.
4538 */
4539 InstallationMediaId?: String;
4540 /**
4541 * A filter that specifies one or more installation media to describe. Supported filters include the following: custom-availability-zone-id - Accepts custom Availability Zone (AZ) identifiers. The results list includes information about only the custom AZs identified by these identifiers. engine - Accepts database engines. The results list includes information about only the database engines identified by these identifiers. For more information about the valid engines for installation media, see ImportInstallationMedia.
4542 */
4543 Filters?: FilterList;
4544 /**
4545 * An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
4546 */
4547 MaxRecords?: IntegerOptional;
4548 /**
4549 * 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.
4550 */
4551 Marker?: String;
4552 }
4553 export interface DescribeOptionGroupOptionsMessage {
4554 /**
4555 * A required parameter. Options available for the given engine name are described.
4556 */
4557 EngineName: String;
4558 /**
4559 * If specified, filters the results to include only options for the specified major engine version.
4560 */
4561 MajorEngineVersion?: String;
4562 /**
4563 * This parameter isn't currently supported.
4564 */
4565 Filters?: FilterList;
4566 /**
4567 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4568 */
4569 MaxRecords?: IntegerOptional;
4570 /**
4571 * 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.
4572 */
4573 Marker?: String;
4574 }
4575 export interface DescribeOptionGroupsMessage {
4576 /**
4577 * The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
4578 */
4579 OptionGroupName?: String;
4580 /**
4581 * This parameter isn't currently supported.
4582 */
4583 Filters?: FilterList;
4584 /**
4585 * 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.
4586 */
4587 Marker?: String;
4588 /**
4589 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4590 */
4591 MaxRecords?: IntegerOptional;
4592 /**
4593 * Filters the list of option groups to only include groups associated with a specific database engine.
4594 */
4595 EngineName?: String;
4596 /**
4597 * 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.
4598 */
4599 MajorEngineVersion?: String;
4600 }
4601 export interface DescribeOrderableDBInstanceOptionsMessage {
4602 /**
4603 * The name of the engine to retrieve DB instance options for.
4604 */
4605 Engine: String;
4606 /**
4607 * The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
4608 */
4609 EngineVersion?: String;
4610 /**
4611 * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
4612 */
4613 DBInstanceClass?: String;
4614 /**
4615 * The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
4616 */
4617 LicenseModel?: String;
4618 /**
4619 * A value that indicates whether to show only VPC or non-VPC offerings.
4620 */
4621 Vpc?: BooleanOptional;
4622 /**
4623 * This parameter isn't currently supported.
4624 */
4625 Filters?: FilterList;
4626 /**
4627 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4628 */
4629 MaxRecords?: IntegerOptional;
4630 /**
4631 * 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 .
4632 */
4633 Marker?: String;
4634 }
4635 export interface DescribePendingMaintenanceActionsMessage {
4636 /**
4637 * The ARN of a resource to return pending maintenance actions for.
4638 */
4639 ResourceIdentifier?: String;
4640 /**
4641 * 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.
4642 */
4643 Filters?: FilterList;
4644 /**
4645 * 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.
4646 */
4647 Marker?: String;
4648 /**
4649 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4650 */
4651 MaxRecords?: IntegerOptional;
4652 }
4653 export interface DescribeReservedDBInstancesMessage {
4654 /**
4655 * The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
4656 */
4657 ReservedDBInstanceId?: String;
4658 /**
4659 * The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
4660 */
4661 ReservedDBInstancesOfferingId?: String;
4662 /**
4663 * The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
4664 */
4665 DBInstanceClass?: String;
4666 /**
4667 * 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
4668 */
4669 Duration?: String;
4670 /**
4671 * The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
4672 */
4673 ProductDescription?: String;
4674 /**
4675 * 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"
4676 */
4677 OfferingType?: String;
4678 /**
4679 * A value that indicates whether to show only those reservations that support Multi-AZ.
4680 */
4681 MultiAZ?: BooleanOptional;
4682 /**
4683 * The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID. AWS Support might request the lease ID for an issue related to a reserved DB instance.
4684 */
4685 LeaseId?: String;
4686 /**
4687 * This parameter isn't currently supported.
4688 */
4689 Filters?: FilterList;
4690 /**
4691 * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4692 */
4693 MaxRecords?: IntegerOptional;
4694 /**
4695 * 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.
4696 */
4697 Marker?: String;
4698 }
4699 export interface DescribeReservedDBInstancesOfferingsMessage {
4700 /**
4701 * 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
4702 */
4703 ReservedDBInstancesOfferingId?: String;
4704 /**
4705 * The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
4706 */
4707 DBInstanceClass?: String;
4708 /**
4709 * Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
4710 */
4711 Duration?: String;
4712 /**
4713 * 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.
4714 */
4715 ProductDescription?: String;
4716 /**
4717 * 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"
4718 */
4719 OfferingType?: String;
4720 /**
4721 * A value that indicates whether to show only those reservations that support Multi-AZ.
4722 */
4723 MultiAZ?: BooleanOptional;
4724 /**
4725 * This parameter isn't currently supported.
4726 */
4727 Filters?: FilterList;
4728 /**
4729 * The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4730 */
4731 MaxRecords?: IntegerOptional;
4732 /**
4733 * 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.
4734 */
4735 Marker?: String;
4736 }
4737 export interface DescribeSourceRegionsMessage {
4738 /**
4739 * The source AWS Region name. For example, us-east-1. Constraints: Must specify a valid AWS Region name.
4740 */
4741 RegionName?: String;
4742 /**
4743 * The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
4744 */
4745 MaxRecords?: IntegerOptional;
4746 /**
4747 * 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.
4748 */
4749 Marker?: String;
4750 /**
4751 * This parameter isn't currently supported.
4752 */
4753 Filters?: FilterList;
4754 }
4755 export interface DescribeValidDBInstanceModificationsMessage {
4756 /**
4757 * The customer identifier or the ARN of your DB instance.
4758 */
4759 DBInstanceIdentifier: String;
4760 }
4761 export interface DescribeValidDBInstanceModificationsResult {
4762 ValidDBInstanceModificationsMessage?: ValidDBInstanceModificationsMessage;
4763 }
4764 export interface DomainMembership {
4765 /**
4766 * The identifier of the Active Directory Domain.
4767 */
4768 Domain?: String;
4769 /**
4770 * The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
4771 */
4772 Status?: String;
4773 /**
4774 * The fully qualified domain name of the Active Directory Domain.
4775 */
4776 FQDN?: String;
4777 /**
4778 * The name of the IAM role to be used when making API calls to the Directory Service.
4779 */
4780 IAMRoleName?: String;
4781 }
4782 export type DomainMembershipList = DomainMembership[];
4783 export type Double = number;
4784 export type DoubleOptional = number;
4785 export interface DoubleRange {
4786 /**
4787 * The minimum value in the range.
4788 */
4789 From?: Double;
4790 /**
4791 * The maximum value in the range.
4792 */
4793 To?: Double;
4794 }
4795 export type DoubleRangeList = DoubleRange[];
4796 export interface DownloadDBLogFilePortionDetails {
4797 /**
4798 * Entries from the specified log file.
4799 */
4800 LogFileData?: String;
4801 /**
4802 * A pagination token that can be used in a later DownloadDBLogFilePortion request.
4803 */
4804 Marker?: String;
4805 /**
4806 * Boolean value that if true, indicates there is more data to be downloaded.
4807 */
4808 AdditionalDataPending?: Boolean;
4809 }
4810 export interface DownloadDBLogFilePortionMessage {
4811 /**
4812 * 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.
4813 */
4814 DBInstanceIdentifier: String;
4815 /**
4816 * The name of the log file to be downloaded.
4817 */
4818 LogFileName: String;
4819 /**
4820 * 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.
4821 */
4822 Marker?: String;
4823 /**
4824 * 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 isn't 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.
4825 */
4826 NumberOfLines?: Integer;
4827 }
4828 export interface EC2SecurityGroup {
4829 /**
4830 * Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
4831 */
4832 Status?: String;
4833 /**
4834 * Specifies the name of the EC2 security group.
4835 */
4836 EC2SecurityGroupName?: String;
4837 /**
4838 * Specifies the id of the EC2 security group.
4839 */
4840 EC2SecurityGroupId?: String;
4841 /**
4842 * Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
4843 */
4844 EC2SecurityGroupOwnerId?: String;
4845 }
4846 export type EC2SecurityGroupList = EC2SecurityGroup[];
4847 export interface Endpoint {
4848 /**
4849 * Specifies the DNS address of the DB instance.
4850 */
4851 Address?: String;
4852 /**
4853 * Specifies the port that the database engine is listening on.
4854 */
4855 Port?: Integer;
4856 /**
4857 * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
4858 */
4859 HostedZoneId?: String;
4860 }
4861 export interface EngineDefaults {
4862 /**
4863 * Specifies the name of the DB parameter group family that the engine default parameters apply to.
4864 */
4865 DBParameterGroupFamily?: String;
4866 /**
4867 * 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 .
4868 */
4869 Marker?: String;
4870 /**
4871 * Contains a list of engine default parameters.
4872 */
4873 Parameters?: ParametersList;
4874 }
4875 export type EngineFamily = "MYSQL"|string;
4876 export type EngineModeList = String[];
4877 export interface Event {
4878 /**
4879 * Provides the identifier for the source of the event.
4880 */
4881 SourceIdentifier?: String;
4882 /**
4883 * Specifies the source type for this event.
4884 */
4885 SourceType?: SourceType;
4886 /**
4887 * Provides the text of this event.
4888 */
4889 Message?: String;
4890 /**
4891 * Specifies the category for the event.
4892 */
4893 EventCategories?: EventCategoriesList;
4894 /**
4895 * Specifies the date and time of the event.
4896 */
4897 Date?: TStamp;
4898 /**
4899 * The Amazon Resource Name (ARN) for the event.
4900 */
4901 SourceArn?: String;
4902 }
4903 export type EventCategoriesList = String[];
4904 export interface EventCategoriesMap {
4905 /**
4906 * The source type that the returned categories belong to
4907 */
4908 SourceType?: String;
4909 /**
4910 * The event categories for the specified source type
4911 */
4912 EventCategories?: EventCategoriesList;
4913 }
4914 export type EventCategoriesMapList = EventCategoriesMap[];
4915 export interface EventCategoriesMessage {
4916 /**
4917 * A list of EventCategoriesMap data types.
4918 */
4919 EventCategoriesMapList?: EventCategoriesMapList;
4920 }
4921 export type EventList = Event[];
4922 export interface EventSubscription {
4923 /**
4924 * The AWS customer account associated with the RDS event notification subscription.
4925 */
4926 CustomerAwsId?: String;
4927 /**
4928 * The RDS event notification subscription Id.
4929 */
4930 CustSubscriptionId?: String;
4931 /**
4932 * The topic ARN of the RDS event notification subscription.
4933 */
4934 SnsTopicArn?: String;
4935 /**
4936 * 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.
4937 */
4938 Status?: String;
4939 /**
4940 * The time the RDS event notification subscription was created.
4941 */
4942 SubscriptionCreationTime?: String;
4943 /**
4944 * The source type for the RDS event notification subscription.
4945 */
4946 SourceType?: String;
4947 /**
4948 * A list of source IDs for the RDS event notification subscription.
4949 */
4950 SourceIdsList?: SourceIdsList;
4951 /**
4952 * A list of event categories for the RDS event notification subscription.
4953 */
4954 EventCategoriesList?: EventCategoriesList;
4955 /**
4956 * A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
4957 */
4958 Enabled?: Boolean;
4959 /**
4960 * The Amazon Resource Name (ARN) for the event subscription.
4961 */
4962 EventSubscriptionArn?: String;
4963 }
4964 export type EventSubscriptionsList = EventSubscription[];
4965 export interface EventSubscriptionsMessage {
4966 /**
4967 * 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.
4968 */
4969 Marker?: String;
4970 /**
4971 * A list of EventSubscriptions data types.
4972 */
4973 EventSubscriptionsList?: EventSubscriptionsList;
4974 }
4975 export interface EventsMessage {
4976 /**
4977 * 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 .
4978 */
4979 Marker?: String;
4980 /**
4981 * A list of Event instances.
4982 */
4983 Events?: EventList;
4984 }
4985 export interface ExportTask {
4986 /**
4987 * A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
4988 */
4989 ExportTaskIdentifier?: String;
4990 /**
4991 * The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
4992 */
4993 SourceArn?: String;
4994 /**
4995 * The data exported from the snapshot. Valid values are the following: database - Export all the data of the snapshot. database.table [table-name] - Export a table of the snapshot. database.schema [schema-name] - Export a database schema of the snapshot. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL. database.schema.table [table-name] - Export a table of the database schema. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.
4996 */
4997 ExportOnly?: StringList;
4998 /**
4999 * The time that the snapshot was created.
5000 */
5001 SnapshotTime?: TStamp;
5002 /**
5003 * The time that the snapshot export task started.
5004 */
5005 TaskStartTime?: TStamp;
5006 /**
5007 * The time that the snapshot export task completed.
5008 */
5009 TaskEndTime?: TStamp;
5010 /**
5011 * The Amazon S3 bucket that the snapshot is exported to.
5012 */
5013 S3Bucket?: String;
5014 /**
5015 * The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
5016 */
5017 S3Prefix?: String;
5018 /**
5019 * The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
5020 */
5021 IamRoleArn?: String;
5022 /**
5023 * The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
5024 */
5025 KmsKeyId?: String;
5026 /**
5027 * The progress status of the export task.
5028 */
5029 Status?: String;
5030 /**
5031 * The progress of the snapshot export task as a percentage.
5032 */
5033 PercentProgress?: Integer;
5034 /**
5035 * The total amount of data exported, in gigabytes.
5036 */
5037 TotalExtractedDataInGB?: Integer;
5038 /**
5039 * The reason the export failed, if it failed.
5040 */
5041 FailureCause?: String;
5042 /**
5043 * A warning about the snapshot export task.
5044 */
5045 WarningMessage?: String;
5046 }
5047 export type ExportTasksList = ExportTask[];
5048 export interface ExportTasksMessage {
5049 /**
5050 * A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.
5051 */
5052 Marker?: String;
5053 /**
5054 * Information about an export of a snapshot to Amazon S3.
5055 */
5056 ExportTasks?: ExportTasksList;
5057 }
5058 export interface FailoverDBClusterMessage {
5059 /**
5060 * A DB cluster identifier to force a failover for. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DBCluster.
5061 */
5062 DBClusterIdentifier: String;
5063 /**
5064 * 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.
5065 */
5066 TargetDBInstanceIdentifier?: String;
5067 }
5068 export interface FailoverDBClusterResult {
5069 DBCluster?: DBCluster;
5070 }
5071 export type FeatureNameList = String[];
5072 export interface Filter {
5073 /**
5074 * The name of the filter. Filter names are case-sensitive.
5075 */
5076 Name: String;
5077 /**
5078 * One or more filter values. Filter values are case-sensitive.
5079 */
5080 Values: FilterValueList;
5081 }
5082 export type FilterList = Filter[];
5083 export type FilterValueList = String[];
5084 export interface GlobalCluster {
5085 /**
5086 * Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
5087 */
5088 GlobalClusterIdentifier?: String;
5089 /**
5090 * 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.
5091 */
5092 GlobalClusterResourceId?: String;
5093 /**
5094 * The Amazon Resource Name (ARN) for the global database cluster.
5095 */
5096 GlobalClusterArn?: String;
5097 /**
5098 * Specifies the current state of this global database cluster.
5099 */
5100 Status?: String;
5101 /**
5102 * The Aurora database engine used by the global database cluster.
5103 */
5104 Engine?: String;
5105 /**
5106 * Indicates the database engine version.
5107 */
5108 EngineVersion?: String;
5109 /**
5110 * The default database name within the new global database cluster.
5111 */
5112 DatabaseName?: String;
5113 /**
5114 * The storage encryption setting for the global database cluster.
5115 */
5116 StorageEncrypted?: BooleanOptional;
5117 /**
5118 * The deletion protection setting for the new global database cluster.
5119 */
5120 DeletionProtection?: BooleanOptional;
5121 /**
5122 * The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
5123 */
5124 GlobalClusterMembers?: GlobalClusterMemberList;
5125 }
5126 export type GlobalClusterList = GlobalCluster[];
5127 export interface GlobalClusterMember {
5128 /**
5129 * The Amazon Resource Name (ARN) for each Aurora cluster.
5130 */
5131 DBClusterArn?: String;
5132 /**
5133 * The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
5134 */
5135 Readers?: ReadersArnList;
5136 /**
5137 * 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.
5138 */
5139 IsWriter?: Boolean;
5140 }
5141 export type GlobalClusterMemberList = GlobalClusterMember[];
5142 export interface GlobalClustersMessage {
5143 /**
5144 * 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.
5145 */
5146 Marker?: String;
5147 /**
5148 * The list of global clusters returned by this request.
5149 */
5150 GlobalClusters?: GlobalClusterList;
5151 }
5152 export type IAMAuthMode = "DISABLED"|"REQUIRED"|string;
5153 export interface IPRange {
5154 /**
5155 * Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
5156 */
5157 Status?: String;
5158 /**
5159 * Specifies the IP range.
5160 */
5161 CIDRIP?: String;
5162 }
5163 export type IPRangeList = IPRange[];
5164 export interface ImportInstallationMediaMessage {
5165 /**
5166 * The identifier of the custom Availability Zone (AZ) to import the installation media to.
5167 */
5168 CustomAvailabilityZoneId: String;
5169 /**
5170 * The name of the database engine to be used for this instance. The list only includes supported DB engines that require an on-premises customer provided license. Valid Values: sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
5171 */
5172 Engine: String;
5173 /**
5174 * 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. The list only includes DB engines that require an on-premises customer provided license. Microsoft SQL Server See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
5175 */
5176 EngineVersion: String;
5177 /**
5178 * The path to the installation medium for the specified DB engine. Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso
5179 */
5180 EngineInstallationMediaPath: String;
5181 /**
5182 * The path to the installation medium for the operating system associated with the specified DB engine. Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso
5183 */
5184 OSInstallationMediaPath: String;
5185 }
5186 export interface InstallationMedia {
5187 /**
5188 * The installation medium ID.
5189 */
5190 InstallationMediaId?: String;
5191 /**
5192 * The custom Availability Zone (AZ) that contains the installation media.
5193 */
5194 CustomAvailabilityZoneId?: String;
5195 /**
5196 * The DB engine.
5197 */
5198 Engine?: String;
5199 /**
5200 * The engine version of the DB engine.
5201 */
5202 EngineVersion?: String;
5203 /**
5204 * The path to the installation medium for the DB engine.
5205 */
5206 EngineInstallationMediaPath?: String;
5207 /**
5208 * The path to the installation medium for the operating system associated with the DB engine.
5209 */
5210 OSInstallationMediaPath?: String;
5211 /**
5212 * The status of the installation medium.
5213 */
5214 Status?: String;
5215 /**
5216 * If an installation media failure occurred, the cause of the failure.
5217 */
5218 FailureCause?: InstallationMediaFailureCause;
5219 }
5220 export interface InstallationMediaFailureCause {
5221 /**
5222 * The reason that an installation media import failed.
5223 */
5224 Message?: String;
5225 }
5226 export type InstallationMediaList = InstallationMedia[];
5227 export interface InstallationMediaMessage {
5228 /**
5229 * An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
5230 */
5231 Marker?: String;
5232 /**
5233 * The list of InstallationMedia objects for the AWS account.
5234 */
5235 InstallationMedia?: InstallationMediaList;
5236 }
5237 export type Integer = number;
5238 export type IntegerOptional = number;
5239 export type KeyList = String[];
5240 export interface ListTagsForResourceMessage {
5241 /**
5242 * 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.
5243 */
5244 ResourceName: String;
5245 /**
5246 * This parameter isn't currently supported.
5247 */
5248 Filters?: FilterList;
5249 }
5250 export type LogTypeList = String[];
5251 export type Long = number;
5252 export type LongOptional = number;
5253 export type MaxRecords = number;
5254 export interface MinimumEngineVersionPerAllowedValue {
5255 /**
5256 * The allowed value for an option setting.
5257 */
5258 AllowedValue?: String;
5259 /**
5260 * The minimum DB engine version required for the allowed value.
5261 */
5262 MinimumEngineVersion?: String;
5263 }
5264 export type MinimumEngineVersionPerAllowedValueList = MinimumEngineVersionPerAllowedValue[];
5265 export interface ModifyCertificatesMessage {
5266 /**
5267 * The new default certificate identifier to override the current one with. To determine the valid values, use the describe-certificates AWS CLI command or the DescribeCertificates API operation.
5268 */
5269 CertificateIdentifier?: String;
5270 /**
5271 * A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
5272 */
5273 RemoveCustomerOverride?: BooleanOptional;
5274 }
5275 export interface ModifyCertificatesResult {
5276 Certificate?: Certificate;
5277 }
5278 export interface ModifyCurrentDBClusterCapacityMessage {
5279 /**
5280 * The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DB cluster.
5281 */
5282 DBClusterIdentifier: String;
5283 /**
5284 * The DB cluster capacity. When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes. Constraints: For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
5285 */
5286 Capacity?: IntegerOptional;
5287 /**
5288 * 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.
5289 */
5290 SecondsBeforeTimeout?: IntegerOptional;
5291 /**
5292 * 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 isn't found in the timeout period.
5293 */
5294 TimeoutAction?: String;
5295 }
5296 export interface ModifyDBClusterEndpointMessage {
5297 /**
5298 * The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
5299 */
5300 DBClusterEndpointIdentifier: String;
5301 /**
5302 * The type of the endpoint. One of: READER, WRITER, ANY.
5303 */
5304 EndpointType?: String;
5305 /**
5306 * List of DB instance identifiers that are part of the custom endpoint group.
5307 */
5308 StaticMembers?: StringList;
5309 /**
5310 * 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.
5311 */
5312 ExcludedMembers?: StringList;
5313 }
5314 export interface ModifyDBClusterMessage {
5315 /**
5316 * The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive. Constraints: This identifier must match the identifier of an existing DB cluster.
5317 */
5318 DBClusterIdentifier: String;
5319 /**
5320 * 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
5321 */
5322 NewDBClusterIdentifier?: String;
5323 /**
5324 * A value that indicates 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 disabled, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, 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. By default, this parameter is disabled.
5325 */
5326 ApplyImmediately?: Boolean;
5327 /**
5328 * 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
5329 */
5330 BackupRetentionPeriod?: IntegerOptional;
5331 /**
5332 * The name of the DB cluster parameter group to use for the DB cluster.
5333 */
5334 DBClusterParameterGroupName?: String;
5335 /**
5336 * A list of VPC security groups that the DB cluster will belong to.
5337 */
5338 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
5339 /**
5340 * 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.
5341 */
5342 Port?: IntegerOptional;
5343 /**
5344 * 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.
5345 */
5346 MasterUserPassword?: String;
5347 /**
5348 * 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 is enabled 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.
5349 */
5350 OptionGroupName?: String;
5351 /**
5352 * 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.
5353 */
5354 PreferredBackupWindow?: String;
5355 /**
5356 * 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.
5357 */
5358 PreferredMaintenanceWindow?: String;
5359 /**
5360 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
5361 */
5362 EnableIAMDatabaseAuthentication?: BooleanOptional;
5363 /**
5364 * 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).
5365 */
5366 BacktrackWindow?: LongOptional;
5367 /**
5368 * The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
5369 */
5370 CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
5371 /**
5372 * 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 ApplyImmediately is enabled. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
5373 */
5374 EngineVersion?: String;
5375 /**
5376 * A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
5377 */
5378 AllowMajorVersionUpgrade?: Boolean;
5379 /**
5380 * The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately. Default: The existing name setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB cluster. The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.
5381 */
5382 DBInstanceParameterGroupName?: String;
5383 /**
5384 * The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.
5385 */
5386 Domain?: String;
5387 /**
5388 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
5389 */
5390 DomainIAMRoleName?: String;
5391 /**
5392 * The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
5393 */
5394 ScalingConfiguration?: ScalingConfiguration;
5395 /**
5396 * A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
5397 */
5398 DeletionProtection?: BooleanOptional;
5399 /**
5400 * 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, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
5401 */
5402 EnableHttpEndpoint?: BooleanOptional;
5403 /**
5404 * A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
5405 */
5406 CopyTagsToSnapshot?: BooleanOptional;
5407 }
5408 export interface ModifyDBClusterParameterGroupMessage {
5409 /**
5410 * The name of the DB cluster parameter group to modify.
5411 */
5412 DBClusterParameterGroupName: String;
5413 /**
5414 * A list of parameters in the DB cluster parameter group to modify.
5415 */
5416 Parameters: ParametersList;
5417 }
5418 export interface ModifyDBClusterResult {
5419 DBCluster?: DBCluster;
5420 }
5421 export interface ModifyDBClusterSnapshotAttributeMessage {
5422 /**
5423 * The identifier for the DB cluster snapshot to modify the attributes for.
5424 */
5425 DBClusterSnapshotIdentifier: String;
5426 /**
5427 * 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.
5428 */
5429 AttributeName: String;
5430 /**
5431 * 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.
5432 */
5433 ValuesToAdd?: AttributeValueList;
5434 /**
5435 * 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.
5436 */
5437 ValuesToRemove?: AttributeValueList;
5438 }
5439 export interface ModifyDBClusterSnapshotAttributeResult {
5440 DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
5441 }
5442 export interface ModifyDBInstanceMessage {
5443 /**
5444 * The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
5445 */
5446 DBInstanceIdentifier: String;
5447 /**
5448 * 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.
5449 */
5450 AllocatedStorage?: IntegerOptional;
5451 /**
5452 * 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 enabled for this request. Default: Uses existing setting
5453 */
5454 DBInstanceClass?: String;
5455 /**
5456 * 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 isn't 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 enable ApplyImmediately. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup
5457 */
5458 DBSubnetGroupName?: String;
5459 /**
5460 * 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.
5461 */
5462 DBSecurityGroups?: DBSecurityGroupNameList;
5463 /**
5464 * 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.
5465 */
5466 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
5467 /**
5468 * A value that indicates 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. By default, this parameter is disabled. If this parameter is disabled, 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 in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
5469 */
5470 ApplyImmediately?: Boolean;
5471 /**
5472 * 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.
5473 */
5474 MasterUserPassword?: String;
5475 /**
5476 * 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. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't 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.
5477 */
5478 DBParameterGroupName?: String;
5479 /**
5480 * 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 enabled 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
5481 */
5482 BackupRetentionPeriod?: IntegerOptional;
5483 /**
5484 * 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
5485 */
5486 PreferredBackupWindow?: String;
5487 /**
5488 * 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
5489 */
5490 PreferredMaintenanceWindow?: String;
5491 /**
5492 * A value that indicates whether 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 enabled for this request.
5493 */
5494 MultiAZ?: BooleanOptional;
5495 /**
5496 * 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 eanbled 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.
5497 */
5498 EngineVersion?: String;
5499 /**
5500 * A value that indicates whether 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: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
5501 */
5502 AllowMajorVersionUpgrade?: Boolean;
5503 /**
5504 * A value that indicates whether 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 results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
5505 */
5506 AutoMinorVersionUpgrade?: BooleanOptional;
5507 /**
5508 * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
5509 */
5510 LicenseModel?: String;
5511 /**
5512 * 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 enabled 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
5513 */
5514 Iops?: IntegerOptional;
5515 /**
5516 * 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 enabled 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
5517 */
5518 OptionGroupName?: String;
5519 /**
5520 * The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. 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
5521 */
5522 NewDBInstanceIdentifier?: String;
5523 /**
5524 * 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 gp2
5525 */
5526 StorageType?: String;
5527 /**
5528 * The ARN from the key store with which to associate the instance for TDE encryption.
5529 */
5530 TdeCredentialArn?: String;
5531 /**
5532 * The password for the given ARN from the key store in order to access the device.
5533 */
5534 TdeCredentialPassword?: String;
5535 /**
5536 * Indicates the certificate that needs to be associated with the instance.
5537 */
5538 CACertificateIdentifier?: String;
5539 /**
5540 * The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain. For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide. For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
5541 */
5542 Domain?: String;
5543 /**
5544 * A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. 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.
5545 */
5546 CopyTagsToSnapshot?: BooleanOptional;
5547 /**
5548 * 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
5549 */
5550 MonitoringInterval?: IntegerOptional;
5551 /**
5552 * 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
5553 */
5554 DBPortNumber?: IntegerOptional;
5555 /**
5556 * A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance 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 enabled for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
5557 */
5558 PubliclyAccessible?: BooleanOptional;
5559 /**
5560 * 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.
5561 */
5562 MonitoringRoleArn?: String;
5563 /**
5564 * The name of the IAM role to use when making API calls to the Directory Service.
5565 */
5566 DomainIAMRoleName?: String;
5567 /**
5568 * 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
5569 */
5570 PromotionTier?: IntegerOptional;
5571 /**
5572 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
5573 */
5574 EnableIAMDatabaseAuthentication?: BooleanOptional;
5575 /**
5576 * A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
5577 */
5578 EnablePerformanceInsights?: BooleanOptional;
5579 /**
5580 * 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. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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.
5581 */
5582 PerformanceInsightsKMSKeyId?: String;
5583 /**
5584 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
5585 */
5586 PerformanceInsightsRetentionPeriod?: IntegerOptional;
5587 /**
5588 * 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.
5589 */
5590 CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
5591 /**
5592 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
5593 */
5594 ProcessorFeatures?: ProcessorFeatureList;
5595 /**
5596 * A value that indicates whether the DB instance class of the DB instance uses its default processor features.
5597 */
5598 UseDefaultProcessorFeatures?: BooleanOptional;
5599 /**
5600 * A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
5601 */
5602 DeletionProtection?: BooleanOptional;
5603 /**
5604 * The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
5605 */
5606 MaxAllocatedStorage?: IntegerOptional;
5607 /**
5608 * A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
5609 */
5610 CertificateRotationRestart?: BooleanOptional;
5611 }
5612 export interface ModifyDBInstanceResult {
5613 DBInstance?: DBInstance;
5614 }
5615 export interface ModifyDBParameterGroupMessage {
5616 /**
5617 * The name of the DB parameter group. Constraints: If supplied, must match the name of an existing DBParameterGroup.
5618 */
5619 DBParameterGroupName: String;
5620 /**
5621 * 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; later 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.
5622 */
5623 Parameters: ParametersList;
5624 }
5625 export interface ModifyDBProxyRequest {
5626 /**
5627 * The identifier for the DBProxy to modify.
5628 */
5629 DBProxyName: String;
5630 /**
5631 * The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
5632 */
5633 NewDBProxyName?: String;
5634 /**
5635 * The new authentication settings for the DBProxy.
5636 */
5637 Auth?: UserAuthConfigList;
5638 /**
5639 * Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
5640 */
5641 RequireTLS?: BooleanOptional;
5642 /**
5643 * The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
5644 */
5645 IdleClientTimeout?: IntegerOptional;
5646 /**
5647 * Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
5648 */
5649 DebugLogging?: BooleanOptional;
5650 /**
5651 * The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
5652 */
5653 RoleArn?: String;
5654 /**
5655 * The new list of security groups for the DBProxy.
5656 */
5657 SecurityGroups?: StringList;
5658 }
5659 export interface ModifyDBProxyResponse {
5660 /**
5661 * The DBProxy object representing the new settings for the proxy.
5662 */
5663 DBProxy?: DBProxy;
5664 }
5665 export interface ModifyDBProxyTargetGroupRequest {
5666 /**
5667 * The name of the new target group to assign to the proxy.
5668 */
5669 TargetGroupName: String;
5670 /**
5671 * The name of the new proxy to which to assign the target group.
5672 */
5673 DBProxyName: String;
5674 /**
5675 * The settings that determine the size and behavior of the connection pool for the target group.
5676 */
5677 ConnectionPoolConfig?: ConnectionPoolConfiguration;
5678 /**
5679 * The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
5680 */
5681 NewName?: String;
5682 }
5683 export interface ModifyDBProxyTargetGroupResponse {
5684 /**
5685 * The settings of the modified DBProxyTarget.
5686 */
5687 DBProxyTargetGroup?: DBProxyTargetGroup;
5688 }
5689 export interface ModifyDBSnapshotAttributeMessage {
5690 /**
5691 * The identifier for the DB snapshot to modify the attributes for.
5692 */
5693 DBSnapshotIdentifier: String;
5694 /**
5695 * 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.
5696 */
5697 AttributeName: String;
5698 /**
5699 * 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.
5700 */
5701 ValuesToAdd?: AttributeValueList;
5702 /**
5703 * 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.
5704 */
5705 ValuesToRemove?: AttributeValueList;
5706 }
5707 export interface ModifyDBSnapshotAttributeResult {
5708 DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
5709 }
5710 export interface ModifyDBSnapshotMessage {
5711 /**
5712 * The identifier of the DB snapshot to modify.
5713 */
5714 DBSnapshotIdentifier: String;
5715 /**
5716 * 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) PostgreSQL For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
5717 */
5718 EngineVersion?: String;
5719 /**
5720 * 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.
5721 */
5722 OptionGroupName?: String;
5723 }
5724 export interface ModifyDBSnapshotResult {
5725 DBSnapshot?: DBSnapshot;
5726 }
5727 export interface ModifyDBSubnetGroupMessage {
5728 /**
5729 * 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
5730 */
5731 DBSubnetGroupName: String;
5732 /**
5733 * The description for the DB subnet group.
5734 */
5735 DBSubnetGroupDescription?: String;
5736 /**
5737 * The EC2 subnet IDs for the DB subnet group.
5738 */
5739 SubnetIds: SubnetIdentifierList;
5740 }
5741 export interface ModifyDBSubnetGroupResult {
5742 DBSubnetGroup?: DBSubnetGroup;
5743 }
5744 export interface ModifyEventSubscriptionMessage {
5745 /**
5746 * The name of the RDS event notification subscription.
5747 */
5748 SubscriptionName: String;
5749 /**
5750 * 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.
5751 */
5752 SnsTopicArn?: String;
5753 /**
5754 * 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 isn't specified, all events are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
5755 */
5756 SourceType?: String;
5757 /**
5758 * 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.
5759 */
5760 EventCategories?: EventCategoriesList;
5761 /**
5762 * A value that indicates whether to activate the subscription.
5763 */
5764 Enabled?: BooleanOptional;
5765 }
5766 export interface ModifyEventSubscriptionResult {
5767 EventSubscription?: EventSubscription;
5768 }
5769 export interface ModifyGlobalClusterMessage {
5770 /**
5771 * The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing global database cluster.
5772 */
5773 GlobalClusterIdentifier?: String;
5774 /**
5775 * 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
5776 */
5777 NewGlobalClusterIdentifier?: String;
5778 /**
5779 * Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.
5780 */
5781 DeletionProtection?: BooleanOptional;
5782 }
5783 export interface ModifyGlobalClusterResult {
5784 GlobalCluster?: GlobalCluster;
5785 }
5786 export interface ModifyOptionGroupMessage {
5787 /**
5788 * 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
5789 */
5790 OptionGroupName: String;
5791 /**
5792 * Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
5793 */
5794 OptionsToInclude?: OptionConfigurationList;
5795 /**
5796 * Options in this list are removed from the option group.
5797 */
5798 OptionsToRemove?: OptionNamesList;
5799 /**
5800 * A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
5801 */
5802 ApplyImmediately?: Boolean;
5803 }
5804 export interface ModifyOptionGroupResult {
5805 OptionGroup?: OptionGroup;
5806 }
5807 export interface Option {
5808 /**
5809 * The name of the option.
5810 */
5811 OptionName?: String;
5812 /**
5813 * The description of the option.
5814 */
5815 OptionDescription?: String;
5816 /**
5817 * Indicate if this option is persistent.
5818 */
5819 Persistent?: Boolean;
5820 /**
5821 * Indicate if this option is permanent.
5822 */
5823 Permanent?: Boolean;
5824 /**
5825 * If required, the port configured for this option to use.
5826 */
5827 Port?: IntegerOptional;
5828 /**
5829 * The version of the option.
5830 */
5831 OptionVersion?: String;
5832 /**
5833 * The option settings for this option.
5834 */
5835 OptionSettings?: OptionSettingConfigurationList;
5836 /**
5837 * If the option requires access to a port, then this DB security group allows access to the port.
5838 */
5839 DBSecurityGroupMemberships?: DBSecurityGroupMembershipList;
5840 /**
5841 * If the option requires access to a port, then this VPC security group allows access to the port.
5842 */
5843 VpcSecurityGroupMemberships?: VpcSecurityGroupMembershipList;
5844 }
5845 export interface OptionConfiguration {
5846 /**
5847 * The configuration of options to include in a group.
5848 */
5849 OptionName: String;
5850 /**
5851 * The optional port for the option.
5852 */
5853 Port?: IntegerOptional;
5854 /**
5855 * The version for the option.
5856 */
5857 OptionVersion?: String;
5858 /**
5859 * A list of DBSecurityGroupMembership name strings used for this option.
5860 */
5861 DBSecurityGroupMemberships?: DBSecurityGroupNameList;
5862 /**
5863 * A list of VpcSecurityGroupMembership name strings used for this option.
5864 */
5865 VpcSecurityGroupMemberships?: VpcSecurityGroupIdList;
5866 /**
5867 * The option settings to include in an option group.
5868 */
5869 OptionSettings?: OptionSettingsList;
5870 }
5871 export type OptionConfigurationList = OptionConfiguration[];
5872 export interface OptionGroup {
5873 /**
5874 * Specifies the name of the option group.
5875 */
5876 OptionGroupName?: String;
5877 /**
5878 * Provides a description of the option group.
5879 */
5880 OptionGroupDescription?: String;
5881 /**
5882 * Indicates the name of the engine that this option group can be applied to.
5883 */
5884 EngineName?: String;
5885 /**
5886 * Indicates the major engine version associated with this option group.
5887 */
5888 MajorEngineVersion?: String;
5889 /**
5890 * Indicates what options are available in the option group.
5891 */
5892 Options?: OptionsList;
5893 /**
5894 * 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.
5895 */
5896 AllowsVpcAndNonVpcInstanceMemberships?: Boolean;
5897 /**
5898 * 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.
5899 */
5900 VpcId?: String;
5901 /**
5902 * The Amazon Resource Name (ARN) for the option group.
5903 */
5904 OptionGroupArn?: String;
5905 }
5906 export interface OptionGroupMembership {
5907 /**
5908 * The name of the option group that the instance belongs to.
5909 */
5910 OptionGroupName?: String;
5911 /**
5912 * 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.
5913 */
5914 Status?: String;
5915 }
5916 export type OptionGroupMembershipList = OptionGroupMembership[];
5917 export interface OptionGroupOption {
5918 /**
5919 * The name of the option.
5920 */
5921 Name?: String;
5922 /**
5923 * The description of the option.
5924 */
5925 Description?: String;
5926 /**
5927 * The name of the engine that this option can be applied to.
5928 */
5929 EngineName?: String;
5930 /**
5931 * Indicates the major engine version that the option is available for.
5932 */
5933 MajorEngineVersion?: String;
5934 /**
5935 * The minimum required engine version for the option to be applied.
5936 */
5937 MinimumRequiredMinorEngineVersion?: String;
5938 /**
5939 * Specifies whether the option requires a port.
5940 */
5941 PortRequired?: Boolean;
5942 /**
5943 * If the option requires a port, specifies the default port for the option.
5944 */
5945 DefaultPort?: IntegerOptional;
5946 /**
5947 * The options that are prerequisites for this option.
5948 */
5949 OptionsDependedOn?: OptionsDependedOn;
5950 /**
5951 * The options that conflict with this option.
5952 */
5953 OptionsConflictsWith?: OptionsConflictsWith;
5954 /**
5955 * 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.
5956 */
5957 Persistent?: Boolean;
5958 /**
5959 * 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.
5960 */
5961 Permanent?: Boolean;
5962 /**
5963 * 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.
5964 */
5965 RequiresAutoMinorEngineVersionUpgrade?: Boolean;
5966 /**
5967 * If true, you can only use this option with a DB instance that is in a VPC.
5968 */
5969 VpcOnly?: Boolean;
5970 /**
5971 * If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
5972 */
5973 SupportsOptionVersionDowngrade?: BooleanOptional;
5974 /**
5975 * The option settings that are available (and the default value) for each option in an option group.
5976 */
5977 OptionGroupOptionSettings?: OptionGroupOptionSettingsList;
5978 /**
5979 * The versions that are available for the option.
5980 */
5981 OptionGroupOptionVersions?: OptionGroupOptionVersionsList;
5982 }
5983 export interface OptionGroupOptionSetting {
5984 /**
5985 * The name of the option group option.
5986 */
5987 SettingName?: String;
5988 /**
5989 * The description of the option group option.
5990 */
5991 SettingDescription?: String;
5992 /**
5993 * The default value for the option group option.
5994 */
5995 DefaultValue?: String;
5996 /**
5997 * The DB engine specific parameter type for the option group option.
5998 */
5999 ApplyType?: String;
6000 /**
6001 * Indicates the acceptable values for the option group option.
6002 */
6003 AllowedValues?: String;
6004 /**
6005 * Boolean value where true indicates that this option group option can be changed from the default value.
6006 */
6007 IsModifiable?: Boolean;
6008 /**
6009 * Boolean value where true indicates that a value must be specified for this option setting of the option group option.
6010 */
6011 IsRequired?: Boolean;
6012 /**
6013 * The minimum DB engine version required for the corresponding allowed value for this option setting.
6014 */
6015 MinimumEngineVersionPerAllowedValue?: MinimumEngineVersionPerAllowedValueList;
6016 }
6017 export type OptionGroupOptionSettingsList = OptionGroupOptionSetting[];
6018 export type OptionGroupOptionVersionsList = OptionVersion[];
6019 export type OptionGroupOptionsList = OptionGroupOption[];
6020 export interface OptionGroupOptionsMessage {
6021 OptionGroupOptions?: OptionGroupOptionsList;
6022 /**
6023 * 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.
6024 */
6025 Marker?: String;
6026 }
6027 export interface OptionGroups {
6028 /**
6029 * List of option groups.
6030 */
6031 OptionGroupsList?: OptionGroupsList;
6032 /**
6033 * 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.
6034 */
6035 Marker?: String;
6036 }
6037 export type OptionGroupsList = OptionGroup[];
6038 export type OptionNamesList = String[];
6039 export interface OptionSetting {
6040 /**
6041 * The name of the option that has settings that you can set.
6042 */
6043 Name?: String;
6044 /**
6045 * The current value of the option setting.
6046 */
6047 Value?: String;
6048 /**
6049 * The default value of the option setting.
6050 */
6051 DefaultValue?: String;
6052 /**
6053 * The description of the option setting.
6054 */
6055 Description?: String;
6056 /**
6057 * The DB engine specific parameter type.
6058 */
6059 ApplyType?: String;
6060 /**
6061 * The data type of the option setting.
6062 */
6063 DataType?: String;
6064 /**
6065 * The allowed values of the option setting.
6066 */
6067 AllowedValues?: String;
6068 /**
6069 * A Boolean value that, when true, indicates the option setting can be modified from the default.
6070 */
6071 IsModifiable?: Boolean;
6072 /**
6073 * Indicates if the option setting is part of a collection.
6074 */
6075 IsCollection?: Boolean;
6076 }
6077 export type OptionSettingConfigurationList = OptionSetting[];
6078 export type OptionSettingsList = OptionSetting[];
6079 export interface OptionVersion {
6080 /**
6081 * The version of the option.
6082 */
6083 Version?: String;
6084 /**
6085 * True if the version is the default version of the option, and otherwise false.
6086 */
6087 IsDefault?: Boolean;
6088 }
6089 export type OptionsConflictsWith = String[];
6090 export type OptionsDependedOn = String[];
6091 export type OptionsList = Option[];
6092 export interface OrderableDBInstanceOption {
6093 /**
6094 * The engine type of a DB instance.
6095 */
6096 Engine?: String;
6097 /**
6098 * The engine version of a DB instance.
6099 */
6100 EngineVersion?: String;
6101 /**
6102 * The DB instance class for a DB instance.
6103 */
6104 DBInstanceClass?: String;
6105 /**
6106 * The license model for a DB instance.
6107 */
6108 LicenseModel?: String;
6109 /**
6110 * A list of Availability Zones for a DB instance.
6111 */
6112 AvailabilityZones?: AvailabilityZoneList;
6113 /**
6114 * Indicates whether a DB instance is Multi-AZ capable.
6115 */
6116 MultiAZCapable?: Boolean;
6117 /**
6118 * Indicates whether a DB instance can have a Read Replica.
6119 */
6120 ReadReplicaCapable?: Boolean;
6121 /**
6122 * Indicates whether a DB instance is in a VPC.
6123 */
6124 Vpc?: Boolean;
6125 /**
6126 * Indicates whether a DB instance supports encrypted storage.
6127 */
6128 SupportsStorageEncryption?: Boolean;
6129 /**
6130 * Indicates the storage type for a DB instance.
6131 */
6132 StorageType?: String;
6133 /**
6134 * Indicates whether a DB instance supports provisioned IOPS.
6135 */
6136 SupportsIops?: Boolean;
6137 /**
6138 * Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
6139 */
6140 SupportsEnhancedMonitoring?: Boolean;
6141 /**
6142 * Indicates whether a DB instance supports IAM database authentication.
6143 */
6144 SupportsIAMDatabaseAuthentication?: Boolean;
6145 /**
6146 * True if a DB instance supports Performance Insights, otherwise false.
6147 */
6148 SupportsPerformanceInsights?: Boolean;
6149 /**
6150 * Minimum storage size for a DB instance.
6151 */
6152 MinStorageSize?: IntegerOptional;
6153 /**
6154 * Maximum storage size for a DB instance.
6155 */
6156 MaxStorageSize?: IntegerOptional;
6157 /**
6158 * Minimum total provisioned IOPS for a DB instance.
6159 */
6160 MinIopsPerDbInstance?: IntegerOptional;
6161 /**
6162 * Maximum total provisioned IOPS for a DB instance.
6163 */
6164 MaxIopsPerDbInstance?: IntegerOptional;
6165 /**
6166 * Minimum provisioned IOPS per GiB for a DB instance.
6167 */
6168 MinIopsPerGib?: DoubleOptional;
6169 /**
6170 * Maximum provisioned IOPS per GiB for a DB instance.
6171 */
6172 MaxIopsPerGib?: DoubleOptional;
6173 /**
6174 * A list of the available processor features for the DB instance class of a DB instance.
6175 */
6176 AvailableProcessorFeatures?: AvailableProcessorFeatureList;
6177 /**
6178 * A list of the supported DB engine modes.
6179 */
6180 SupportedEngineModes?: EngineModeList;
6181 /**
6182 * Whether or not Amazon RDS can automatically scale storage for DB instances that use the specified instance class.
6183 */
6184 SupportsStorageAutoscaling?: BooleanOptional;
6185 /**
6186 * Whether a DB instance supports Kerberos Authentication.
6187 */
6188 SupportsKerberosAuthentication?: BooleanOptional;
6189 }
6190 export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[];
6191 export interface OrderableDBInstanceOptionsMessage {
6192 /**
6193 * An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
6194 */
6195 OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList;
6196 /**
6197 * 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 .
6198 */
6199 Marker?: String;
6200 }
6201 export interface Parameter {
6202 /**
6203 * Specifies the name of the parameter.
6204 */
6205 ParameterName?: String;
6206 /**
6207 * Specifies the value of the parameter.
6208 */
6209 ParameterValue?: String;
6210 /**
6211 * Provides a description of the parameter.
6212 */
6213 Description?: String;
6214 /**
6215 * Indicates the source of the parameter value.
6216 */
6217 Source?: String;
6218 /**
6219 * Specifies the engine specific parameters type.
6220 */
6221 ApplyType?: String;
6222 /**
6223 * Specifies the valid data type for the parameter.
6224 */
6225 DataType?: String;
6226 /**
6227 * Specifies the valid range of values for the parameter.
6228 */
6229 AllowedValues?: String;
6230 /**
6231 * Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
6232 */
6233 IsModifiable?: Boolean;
6234 /**
6235 * The earliest engine version to which the parameter can apply.
6236 */
6237 MinimumEngineVersion?: String;
6238 /**
6239 * Indicates when to apply parameter updates.
6240 */
6241 ApplyMethod?: ApplyMethod;
6242 /**
6243 * The valid DB engine modes.
6244 */
6245 SupportedEngineModes?: EngineModeList;
6246 }
6247 export type ParametersList = Parameter[];
6248 export interface PendingCloudwatchLogsExports {
6249 /**
6250 * Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
6251 */
6252 LogTypesToEnable?: LogTypeList;
6253 /**
6254 * Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
6255 */
6256 LogTypesToDisable?: LogTypeList;
6257 }
6258 export interface PendingMaintenanceAction {
6259 /**
6260 * The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.
6261 */
6262 Action?: String;
6263 /**
6264 * 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.
6265 */
6266 AutoAppliedAfterDate?: TStamp;
6267 /**
6268 * 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.
6269 */
6270 ForcedApplyDate?: TStamp;
6271 /**
6272 * Indicates the type of opt-in request that has been received for the resource.
6273 */
6274 OptInStatus?: String;
6275 /**
6276 * 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.
6277 */
6278 CurrentApplyDate?: TStamp;
6279 /**
6280 * A description providing more detail about the maintenance action.
6281 */
6282 Description?: String;
6283 }
6284 export type PendingMaintenanceActionDetails = PendingMaintenanceAction[];
6285 export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[];
6286 export interface PendingMaintenanceActionsMessage {
6287 /**
6288 * A list of the pending maintenance actions for the resource.
6289 */
6290 PendingMaintenanceActions?: PendingMaintenanceActions;
6291 /**
6292 * 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.
6293 */
6294 Marker?: String;
6295 }
6296 export interface PendingModifiedValues {
6297 /**
6298 * Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
6299 */
6300 DBInstanceClass?: String;
6301 /**
6302 * Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
6303 */
6304 AllocatedStorage?: IntegerOptional;
6305 /**
6306 * Contains the pending or currently-in-progress change of the master credentials for the DB instance.
6307 */
6308 MasterUserPassword?: String;
6309 /**
6310 * Specifies the pending port for the DB instance.
6311 */
6312 Port?: IntegerOptional;
6313 /**
6314 * Specifies the pending number of days for which automated backups are retained.
6315 */
6316 BackupRetentionPeriod?: IntegerOptional;
6317 /**
6318 * Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
6319 */
6320 MultiAZ?: BooleanOptional;
6321 /**
6322 * Indicates the database engine version.
6323 */
6324 EngineVersion?: String;
6325 /**
6326 * The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
6327 */
6328 LicenseModel?: String;
6329 /**
6330 * Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
6331 */
6332 Iops?: IntegerOptional;
6333 /**
6334 * Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
6335 */
6336 DBInstanceIdentifier?: String;
6337 /**
6338 * Specifies the storage type to be associated with the DB instance.
6339 */
6340 StorageType?: String;
6341 /**
6342 * Specifies the identifier of the CA certificate for the DB instance.
6343 */
6344 CACertificateIdentifier?: String;
6345 /**
6346 * The new DB subnet group for the DB instance.
6347 */
6348 DBSubnetGroupName?: String;
6349 PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports;
6350 /**
6351 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
6352 */
6353 ProcessorFeatures?: ProcessorFeatureList;
6354 }
6355 export interface ProcessorFeature {
6356 /**
6357 * The name of the processor feature. Valid names are coreCount and threadsPerCore.
6358 */
6359 Name?: String;
6360 /**
6361 * The value of a processor feature name.
6362 */
6363 Value?: String;
6364 }
6365 export type ProcessorFeatureList = ProcessorFeature[];
6366 export interface PromoteReadReplicaDBClusterMessage {
6367 /**
6368 * The identifier of the DB cluster Read Replica to promote. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DBCluster Read Replica. Example: my-cluster-replica1
6369 */
6370 DBClusterIdentifier: String;
6371 }
6372 export interface PromoteReadReplicaDBClusterResult {
6373 DBCluster?: DBCluster;
6374 }
6375 export interface PromoteReadReplicaMessage {
6376 /**
6377 * 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
6378 */
6379 DBInstanceIdentifier: String;
6380 /**
6381 * The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: Must be a value from 0 to 35. Can't be set to 0 if the DB instance is a source to Read Replicas.
6382 */
6383 BackupRetentionPeriod?: IntegerOptional;
6384 /**
6385 * 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.
6386 */
6387 PreferredBackupWindow?: String;
6388 }
6389 export interface PromoteReadReplicaResult {
6390 DBInstance?: DBInstance;
6391 }
6392 export interface PurchaseReservedDBInstancesOfferingMessage {
6393 /**
6394 * The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
6395 */
6396 ReservedDBInstancesOfferingId: String;
6397 /**
6398 * Customer-specified identifier to track this reservation. Example: myreservationID
6399 */
6400 ReservedDBInstanceId?: String;
6401 /**
6402 * The number of instances to reserve. Default: 1
6403 */
6404 DBInstanceCount?: IntegerOptional;
6405 Tags?: TagList;
6406 }
6407 export interface PurchaseReservedDBInstancesOfferingResult {
6408 ReservedDBInstance?: ReservedDBInstance;
6409 }
6410 export interface Range {
6411 /**
6412 * The minimum value in the range.
6413 */
6414 From?: Integer;
6415 /**
6416 * The maximum value in the range.
6417 */
6418 To?: Integer;
6419 /**
6420 * 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...
6421 */
6422 Step?: IntegerOptional;
6423 }
6424 export type RangeList = Range[];
6425 export type ReadReplicaDBClusterIdentifierList = String[];
6426 export type ReadReplicaDBInstanceIdentifierList = String[];
6427 export type ReadReplicaIdentifierList = String[];
6428 export type ReadersArnList = String[];
6429 export interface RebootDBInstanceMessage {
6430 /**
6431 * The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
6432 */
6433 DBInstanceIdentifier: String;
6434 /**
6435 * A value that indicates whether the reboot is conducted through a Multi-AZ failover. Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
6436 */
6437 ForceFailover?: BooleanOptional;
6438 }
6439 export interface RebootDBInstanceResult {
6440 DBInstance?: DBInstance;
6441 }
6442 export interface RecurringCharge {
6443 /**
6444 * The amount of the recurring charge.
6445 */
6446 RecurringChargeAmount?: Double;
6447 /**
6448 * The frequency of the recurring charge.
6449 */
6450 RecurringChargeFrequency?: String;
6451 }
6452 export type RecurringChargeList = RecurringCharge[];
6453 export interface RegisterDBProxyTargetsRequest {
6454 /**
6455 * The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
6456 */
6457 DBProxyName: String;
6458 /**
6459 * The identifier of the DBProxyTargetGroup.
6460 */
6461 TargetGroupName?: String;
6462 /**
6463 * One or more DB instance identifiers.
6464 */
6465 DBInstanceIdentifiers?: StringList;
6466 /**
6467 * One or more DB cluster identifiers.
6468 */
6469 DBClusterIdentifiers?: StringList;
6470 }
6471 export interface RegisterDBProxyTargetsResponse {
6472 /**
6473 * One or more DBProxyTarget objects that are created when you register targets with a target group.
6474 */
6475 DBProxyTargets?: TargetList;
6476 }
6477 export interface RemoveFromGlobalClusterMessage {
6478 /**
6479 * The cluster identifier to detach from the Aurora global database cluster.
6480 */
6481 GlobalClusterIdentifier?: String;
6482 /**
6483 * The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
6484 */
6485 DbClusterIdentifier?: String;
6486 }
6487 export interface RemoveFromGlobalClusterResult {
6488 GlobalCluster?: GlobalCluster;
6489 }
6490 export interface RemoveRoleFromDBClusterMessage {
6491 /**
6492 * The name of the DB cluster to disassociate the IAM role from.
6493 */
6494 DBClusterIdentifier: String;
6495 /**
6496 * The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
6497 */
6498 RoleArn: String;
6499 /**
6500 * The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.
6501 */
6502 FeatureName?: String;
6503 }
6504 export interface RemoveRoleFromDBInstanceMessage {
6505 /**
6506 * The name of the DB instance to disassociate the IAM role from.
6507 */
6508 DBInstanceIdentifier: String;
6509 /**
6510 * The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
6511 */
6512 RoleArn: String;
6513 /**
6514 * 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.
6515 */
6516 FeatureName: String;
6517 }
6518 export interface RemoveSourceIdentifierFromSubscriptionMessage {
6519 /**
6520 * The name of the RDS event notification subscription you want to remove a source identifier from.
6521 */
6522 SubscriptionName: String;
6523 /**
6524 * 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.
6525 */
6526 SourceIdentifier: String;
6527 }
6528 export interface RemoveSourceIdentifierFromSubscriptionResult {
6529 EventSubscription?: EventSubscription;
6530 }
6531 export interface RemoveTagsFromResourceMessage {
6532 /**
6533 * 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.
6534 */
6535 ResourceName: String;
6536 /**
6537 * The tag key (name) of the tag to be removed.
6538 */
6539 TagKeys: KeyList;
6540 }
6541 export interface ReservedDBInstance {
6542 /**
6543 * The unique identifier for the reservation.
6544 */
6545 ReservedDBInstanceId?: String;
6546 /**
6547 * The offering identifier.
6548 */
6549 ReservedDBInstancesOfferingId?: String;
6550 /**
6551 * The DB instance class for the reserved DB instance.
6552 */
6553 DBInstanceClass?: String;
6554 /**
6555 * The time the reservation started.
6556 */
6557 StartTime?: TStamp;
6558 /**
6559 * The duration of the reservation in seconds.
6560 */
6561 Duration?: Integer;
6562 /**
6563 * The fixed price charged for this reserved DB instance.
6564 */
6565 FixedPrice?: Double;
6566 /**
6567 * The hourly price charged for this reserved DB instance.
6568 */
6569 UsagePrice?: Double;
6570 /**
6571 * The currency code for the reserved DB instance.
6572 */
6573 CurrencyCode?: String;
6574 /**
6575 * The number of reserved DB instances.
6576 */
6577 DBInstanceCount?: Integer;
6578 /**
6579 * The description of the reserved DB instance.
6580 */
6581 ProductDescription?: String;
6582 /**
6583 * The offering type of this reserved DB instance.
6584 */
6585 OfferingType?: String;
6586 /**
6587 * Indicates if the reservation applies to Multi-AZ deployments.
6588 */
6589 MultiAZ?: Boolean;
6590 /**
6591 * The state of the reserved DB instance.
6592 */
6593 State?: String;
6594 /**
6595 * The recurring price charged to run this reserved DB instance.
6596 */
6597 RecurringCharges?: RecurringChargeList;
6598 /**
6599 * The Amazon Resource Name (ARN) for the reserved DB instance.
6600 */
6601 ReservedDBInstanceArn?: String;
6602 /**
6603 * The unique identifier for the lease associated with the reserved DB instance. AWS Support might request the lease ID for an issue related to a reserved DB instance.
6604 */
6605 LeaseId?: String;
6606 }
6607 export type ReservedDBInstanceList = ReservedDBInstance[];
6608 export interface ReservedDBInstanceMessage {
6609 /**
6610 * 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.
6611 */
6612 Marker?: String;
6613 /**
6614 * A list of reserved DB instances.
6615 */
6616 ReservedDBInstances?: ReservedDBInstanceList;
6617 }
6618 export interface ReservedDBInstancesOffering {
6619 /**
6620 * The offering identifier.
6621 */
6622 ReservedDBInstancesOfferingId?: String;
6623 /**
6624 * The DB instance class for the reserved DB instance.
6625 */
6626 DBInstanceClass?: String;
6627 /**
6628 * The duration of the offering in seconds.
6629 */
6630 Duration?: Integer;
6631 /**
6632 * The fixed price charged for this offering.
6633 */
6634 FixedPrice?: Double;
6635 /**
6636 * The hourly price charged for this offering.
6637 */
6638 UsagePrice?: Double;
6639 /**
6640 * The currency code for the reserved DB instance offering.
6641 */
6642 CurrencyCode?: String;
6643 /**
6644 * The database engine used by the offering.
6645 */
6646 ProductDescription?: String;
6647 /**
6648 * The offering type.
6649 */
6650 OfferingType?: String;
6651 /**
6652 * Indicates if the offering applies to Multi-AZ deployments.
6653 */
6654 MultiAZ?: Boolean;
6655 /**
6656 * The recurring price charged to run this reserved DB instance.
6657 */
6658 RecurringCharges?: RecurringChargeList;
6659 }
6660 export type ReservedDBInstancesOfferingList = ReservedDBInstancesOffering[];
6661 export interface ReservedDBInstancesOfferingMessage {
6662 /**
6663 * 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.
6664 */
6665 Marker?: String;
6666 /**
6667 * A list of reserved DB instance offerings.
6668 */
6669 ReservedDBInstancesOfferings?: ReservedDBInstancesOfferingList;
6670 }
6671 export interface ResetDBClusterParameterGroupMessage {
6672 /**
6673 * The name of the DB cluster parameter group to reset.
6674 */
6675 DBClusterParameterGroupName: String;
6676 /**
6677 * A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
6678 */
6679 ResetAllParameters?: Boolean;
6680 /**
6681 * 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 enabled.
6682 */
6683 Parameters?: ParametersList;
6684 }
6685 export interface ResetDBParameterGroupMessage {
6686 /**
6687 * The name of the DB parameter group. Constraints: Must match the name of an existing DBParameterGroup.
6688 */
6689 DBParameterGroupName: String;
6690 /**
6691 * A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
6692 */
6693 ResetAllParameters?: Boolean;
6694 /**
6695 * 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
6696 */
6697 Parameters?: ParametersList;
6698 }
6699 export interface ResourcePendingMaintenanceActions {
6700 /**
6701 * The ARN of the resource that has pending maintenance actions.
6702 */
6703 ResourceIdentifier?: String;
6704 /**
6705 * A list that provides details about the pending maintenance actions for the resource.
6706 */
6707 PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails;
6708 }
6709 export interface RestoreDBClusterFromS3Message {
6710 /**
6711 * A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
6712 */
6713 AvailabilityZones?: AvailabilityZones;
6714 /**
6715 * 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
6716 */
6717 BackupRetentionPeriod?: IntegerOptional;
6718 /**
6719 * A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
6720 */
6721 CharacterSetName?: String;
6722 /**
6723 * The database name for the restored DB cluster.
6724 */
6725 DatabaseName?: String;
6726 /**
6727 * 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
6728 */
6729 DBClusterIdentifier: String;
6730 /**
6731 * 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.
6732 */
6733 DBClusterParameterGroupName?: String;
6734 /**
6735 * A list of EC2 VPC security groups to associate with the restored DB cluster.
6736 */
6737 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
6738 /**
6739 * A DB subnet group to associate with the restored DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
6740 */
6741 DBSubnetGroupName?: String;
6742 /**
6743 * The name of the database engine to be used for the restored DB cluster. Valid Values: aurora, aurora-postgresql
6744 */
6745 Engine: String;
6746 /**
6747 * The version number of the database engine to use. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" Aurora MySQL Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5 Aurora PostgreSQL Example: 9.6.3, 10.7
6748 */
6749 EngineVersion?: String;
6750 /**
6751 * The port number on which the instances in the restored DB cluster accept connections. Default: 3306
6752 */
6753 Port?: IntegerOptional;
6754 /**
6755 * 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.
6756 */
6757 MasterUsername: String;
6758 /**
6759 * 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.
6760 */
6761 MasterUserPassword: String;
6762 /**
6763 * 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.
6764 */
6765 OptionGroupName?: String;
6766 /**
6767 * 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.
6768 */
6769 PreferredBackupWindow?: String;
6770 /**
6771 * 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.
6772 */
6773 PreferredMaintenanceWindow?: String;
6774 Tags?: TagList;
6775 /**
6776 * A value that indicates whether the restored DB cluster is encrypted.
6777 */
6778 StorageEncrypted?: BooleanOptional;
6779 /**
6780 * 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 enabled, 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.
6781 */
6782 KmsKeyId?: String;
6783 /**
6784 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
6785 */
6786 EnableIAMDatabaseAuthentication?: BooleanOptional;
6787 /**
6788 * The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: mysql
6789 */
6790 SourceEngine: String;
6791 /**
6792 * 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
6793 */
6794 SourceEngineVersion: String;
6795 /**
6796 * The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
6797 */
6798 S3BucketName: String;
6799 /**
6800 * 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.
6801 */
6802 S3Prefix?: String;
6803 /**
6804 * 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.
6805 */
6806 S3IngestionRoleArn: String;
6807 /**
6808 * 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).
6809 */
6810 BacktrackWindow?: LongOptional;
6811 /**
6812 * 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.
6813 */
6814 EnableCloudwatchLogsExports?: LogTypeList;
6815 /**
6816 * A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
6817 */
6818 DeletionProtection?: BooleanOptional;
6819 /**
6820 * A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
6821 */
6822 CopyTagsToSnapshot?: BooleanOptional;
6823 /**
6824 * Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Using Kerberos Authentication for Aurora MySQL in the Amazon Aurora User Guide.
6825 */
6826 Domain?: String;
6827 /**
6828 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
6829 */
6830 DomainIAMRoleName?: String;
6831 }
6832 export interface RestoreDBClusterFromS3Result {
6833 DBCluster?: DBCluster;
6834 }
6835 export interface RestoreDBClusterFromSnapshotMessage {
6836 /**
6837 * Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
6838 */
6839 AvailabilityZones?: AvailabilityZones;
6840 /**
6841 * 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
6842 */
6843 DBClusterIdentifier: String;
6844 /**
6845 * 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.
6846 */
6847 SnapshotIdentifier: String;
6848 /**
6849 * 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
6850 */
6851 Engine: String;
6852 /**
6853 * The version of the database engine to use for the new DB cluster. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" If you aren't using the default engine version, then you must specify the engine version. Aurora MySQL Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5 Aurora PostgreSQL Example: 9.6.3, 10.7
6854 */
6855 EngineVersion?: String;
6856 /**
6857 * 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.
6858 */
6859 Port?: IntegerOptional;
6860 /**
6861 * 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
6862 */
6863 DBSubnetGroupName?: String;
6864 /**
6865 * The database name for the restored DB cluster.
6866 */
6867 DatabaseName?: String;
6868 /**
6869 * The name of the option group to use for the restored DB cluster.
6870 */
6871 OptionGroupName?: String;
6872 /**
6873 * A list of VPC security groups that the new DB cluster will belong to.
6874 */
6875 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
6876 /**
6877 * The tags to be assigned to the restored DB cluster.
6878 */
6879 Tags?: TagList;
6880 /**
6881 * 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 isn't encrypted, then the restored DB cluster isn't encrypted.
6882 */
6883 KmsKeyId?: String;
6884 /**
6885 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
6886 */
6887 EnableIAMDatabaseAuthentication?: BooleanOptional;
6888 /**
6889 * 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).
6890 */
6891 BacktrackWindow?: LongOptional;
6892 /**
6893 * 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.
6894 */
6895 EnableCloudwatchLogsExports?: LogTypeList;
6896 /**
6897 * The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
6898 */
6899 EngineMode?: String;
6900 /**
6901 * For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
6902 */
6903 ScalingConfiguration?: ScalingConfiguration;
6904 /**
6905 * 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.
6906 */
6907 DBClusterParameterGroupName?: String;
6908 /**
6909 * A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
6910 */
6911 DeletionProtection?: BooleanOptional;
6912 /**
6913 * A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
6914 */
6915 CopyTagsToSnapshot?: BooleanOptional;
6916 /**
6917 * Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
6918 */
6919 Domain?: String;
6920 /**
6921 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
6922 */
6923 DomainIAMRoleName?: String;
6924 }
6925 export interface RestoreDBClusterFromSnapshotResult {
6926 DBCluster?: DBCluster;
6927 }
6928 export interface RestoreDBClusterToPointInTimeMessage {
6929 /**
6930 * 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
6931 */
6932 DBClusterIdentifier: String;
6933 /**
6934 * 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.
6935 */
6936 RestoreType?: String;
6937 /**
6938 * The identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster.
6939 */
6940 SourceDBClusterIdentifier: String;
6941 /**
6942 * 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 isn't provided Can't be specified if the UseLatestRestorableTime parameter is enabled Can't be specified if the RestoreType parameter is copy-on-write Example: 2015-03-07T23:45:00Z
6943 */
6944 RestoreToTime?: TStamp;
6945 /**
6946 * A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time. Constraints: Can't be specified if RestoreToTime parameter is provided.
6947 */
6948 UseLatestRestorableTime?: Boolean;
6949 /**
6950 * The port number on which the new DB cluster accepts connections. Constraints: A value from 1150-65535. Default: The default port for the engine.
6951 */
6952 Port?: IntegerOptional;
6953 /**
6954 * 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
6955 */
6956 DBSubnetGroupName?: String;
6957 /**
6958 * The name of the option group for the new DB cluster.
6959 */
6960 OptionGroupName?: String;
6961 /**
6962 * A list of VPC security groups that the new DB cluster belongs to.
6963 */
6964 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
6965 Tags?: TagList;
6966 /**
6967 * 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 isn't encrypted, then the restored DB cluster isn't encrypted. If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
6968 */
6969 KmsKeyId?: String;
6970 /**
6971 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
6972 */
6973 EnableIAMDatabaseAuthentication?: BooleanOptional;
6974 /**
6975 * 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).
6976 */
6977 BacktrackWindow?: LongOptional;
6978 /**
6979 * 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.
6980 */
6981 EnableCloudwatchLogsExports?: LogTypeList;
6982 /**
6983 * 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.
6984 */
6985 DBClusterParameterGroupName?: String;
6986 /**
6987 * A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
6988 */
6989 DeletionProtection?: BooleanOptional;
6990 /**
6991 * A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
6992 */
6993 CopyTagsToSnapshot?: BooleanOptional;
6994 /**
6995 * Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Using Kerberos Authentication for Aurora MySQL in the Amazon Aurora User Guide.
6996 */
6997 Domain?: String;
6998 /**
6999 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
7000 */
7001 DomainIAMRoleName?: String;
7002 }
7003 export interface RestoreDBClusterToPointInTimeResult {
7004 DBCluster?: DBCluster;
7005 }
7006 export interface RestoreDBInstanceFromDBSnapshotMessage {
7007 /**
7008 * 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
7009 */
7010 DBInstanceIdentifier: String;
7011 /**
7012 * 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.
7013 */
7014 DBSnapshotIdentifier: String;
7015 /**
7016 * 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.
7017 */
7018 DBInstanceClass?: String;
7019 /**
7020 * The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be 1150-65535
7021 */
7022 Port?: IntegerOptional;
7023 /**
7024 * The Availability Zone (AZ) where the DB instance will be created. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example: us-east-1a
7025 */
7026 AvailabilityZone?: String;
7027 /**
7028 * The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
7029 */
7030 DBSubnetGroupName?: String;
7031 /**
7032 * A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
7033 */
7034 MultiAZ?: BooleanOptional;
7035 /**
7036 * A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
7037 */
7038 PubliclyAccessible?: BooleanOptional;
7039 /**
7040 * A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
7041 */
7042 AutoMinorVersionUpgrade?: BooleanOptional;
7043 /**
7044 * License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
7045 */
7046 LicenseModel?: String;
7047 /**
7048 * The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
7049 */
7050 DBName?: String;
7051 /**
7052 * 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
7053 */
7054 Engine?: String;
7055 /**
7056 * Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't 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.
7057 */
7058 Iops?: IntegerOptional;
7059 /**
7060 * 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
7061 */
7062 OptionGroupName?: String;
7063 Tags?: TagList;
7064 /**
7065 * 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 gp2
7066 */
7067 StorageType?: String;
7068 /**
7069 * The ARN from the key store with which to associate the instance for TDE encryption.
7070 */
7071 TdeCredentialArn?: String;
7072 /**
7073 * The password for the given ARN from the key store in order to access the device.
7074 */
7075 TdeCredentialPassword?: String;
7076 /**
7077 * 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.
7078 */
7079 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
7080 /**
7081 * Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain. For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide. For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
7082 */
7083 Domain?: String;
7084 /**
7085 * A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
7086 */
7087 CopyTagsToSnapshot?: BooleanOptional;
7088 /**
7089 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
7090 */
7091 DomainIAMRoleName?: String;
7092 /**
7093 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
7094 */
7095 EnableIAMDatabaseAuthentication?: BooleanOptional;
7096 /**
7097 * 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.
7098 */
7099 EnableCloudwatchLogsExports?: LogTypeList;
7100 /**
7101 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
7102 */
7103 ProcessorFeatures?: ProcessorFeatureList;
7104 /**
7105 * A value that indicates whether the DB instance class of the DB instance uses its default processor features.
7106 */
7107 UseDefaultProcessorFeatures?: BooleanOptional;
7108 /**
7109 * The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB 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.
7110 */
7111 DBParameterGroupName?: String;
7112 /**
7113 * A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
7114 */
7115 DeletionProtection?: BooleanOptional;
7116 }
7117 export interface RestoreDBInstanceFromDBSnapshotResult {
7118 DBInstance?: DBInstance;
7119 }
7120 export interface RestoreDBInstanceFromS3Message {
7121 /**
7122 * The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
7123 */
7124 DBName?: String;
7125 /**
7126 * 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
7127 */
7128 DBInstanceIdentifier: String;
7129 /**
7130 * 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.
7131 */
7132 AllocatedStorage?: IntegerOptional;
7133 /**
7134 * 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 isn't supported on the db.t2.micro DB instance class.
7135 */
7136 DBInstanceClass: String;
7137 /**
7138 * The name of the database engine to be used for this instance. Valid Values: mysql
7139 */
7140 Engine: String;
7141 /**
7142 * 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.
7143 */
7144 MasterUsername?: String;
7145 /**
7146 * The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
7147 */
7148 MasterUserPassword?: String;
7149 /**
7150 * A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
7151 */
7152 DBSecurityGroups?: DBSecurityGroupNameList;
7153 /**
7154 * A list of VPC security groups to associate with this DB instance.
7155 */
7156 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
7157 /**
7158 * 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 DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.
7159 */
7160 AvailabilityZone?: String;
7161 /**
7162 * A DB subnet group to associate with this DB instance.
7163 */
7164 DBSubnetGroupName?: String;
7165 /**
7166 * 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.
7167 */
7168 PreferredMaintenanceWindow?: String;
7169 /**
7170 * The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
7171 */
7172 DBParameterGroupName?: String;
7173 /**
7174 * The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
7175 */
7176 BackupRetentionPeriod?: IntegerOptional;
7177 /**
7178 * 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.
7179 */
7180 PreferredBackupWindow?: String;
7181 /**
7182 * The port number on which the database accepts connections. Type: Integer Valid Values: 1150-65535 Default: 3306
7183 */
7184 Port?: IntegerOptional;
7185 /**
7186 * A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
7187 */
7188 MultiAZ?: BooleanOptional;
7189 /**
7190 * 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.
7191 */
7192 EngineVersion?: String;
7193 /**
7194 * A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
7195 */
7196 AutoMinorVersionUpgrade?: BooleanOptional;
7197 /**
7198 * The license model for this DB instance. Use general-public-license.
7199 */
7200 LicenseModel?: String;
7201 /**
7202 * The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
7203 */
7204 Iops?: IntegerOptional;
7205 /**
7206 * 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.
7207 */
7208 OptionGroupName?: String;
7209 /**
7210 * A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
7211 */
7212 PubliclyAccessible?: BooleanOptional;
7213 /**
7214 * A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
7215 */
7216 Tags?: TagList;
7217 /**
7218 * 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 gp2
7219 */
7220 StorageType?: String;
7221 /**
7222 * A value that indicates whether the new DB instance is encrypted or not.
7223 */
7224 StorageEncrypted?: BooleanOptional;
7225 /**
7226 * 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 enabled, 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.
7227 */
7228 KmsKeyId?: String;
7229 /**
7230 * A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
7231 */
7232 CopyTagsToSnapshot?: BooleanOptional;
7233 /**
7234 * 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
7235 */
7236 MonitoringInterval?: IntegerOptional;
7237 /**
7238 * 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.
7239 */
7240 MonitoringRoleArn?: String;
7241 /**
7242 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
7243 */
7244 EnableIAMDatabaseAuthentication?: BooleanOptional;
7245 /**
7246 * The name of the engine of your source database. Valid Values: mysql
7247 */
7248 SourceEngine: String;
7249 /**
7250 * The engine version of your source database. Valid Values: 5.6
7251 */
7252 SourceEngineVersion: String;
7253 /**
7254 * The name of your Amazon S3 bucket that contains your database backup file.
7255 */
7256 S3BucketName: String;
7257 /**
7258 * The prefix of your Amazon S3 bucket.
7259 */
7260 S3Prefix?: String;
7261 /**
7262 * An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
7263 */
7264 S3IngestionRoleArn: String;
7265 /**
7266 * A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
7267 */
7268 EnablePerformanceInsights?: BooleanOptional;
7269 /**
7270 * 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. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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.
7271 */
7272 PerformanceInsightsKMSKeyId?: String;
7273 /**
7274 * The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
7275 */
7276 PerformanceInsightsRetentionPeriod?: IntegerOptional;
7277 /**
7278 * 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.
7279 */
7280 EnableCloudwatchLogsExports?: LogTypeList;
7281 /**
7282 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
7283 */
7284 ProcessorFeatures?: ProcessorFeatureList;
7285 /**
7286 * A value that indicates whether the DB instance class of the DB instance uses its default processor features.
7287 */
7288 UseDefaultProcessorFeatures?: BooleanOptional;
7289 /**
7290 * A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
7291 */
7292 DeletionProtection?: BooleanOptional;
7293 }
7294 export interface RestoreDBInstanceFromS3Result {
7295 DBInstance?: DBInstance;
7296 }
7297 export interface RestoreDBInstanceToPointInTimeMessage {
7298 /**
7299 * The identifier of the source DB instance from which to restore. Constraints: Must match the identifier of an existing DB instance.
7300 */
7301 SourceDBInstanceIdentifier?: String;
7302 /**
7303 * 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
7304 */
7305 TargetDBInstanceIdentifier: String;
7306 /**
7307 * 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 the UseLatestRestorableTime parameter is enabled Example: 2009-09-07T23:45:00Z
7308 */
7309 RestoreTime?: TStamp;
7310 /**
7311 * A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: Can't be specified if the RestoreTime parameter is provided.
7312 */
7313 UseLatestRestorableTime?: Boolean;
7314 /**
7315 * 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.
7316 */
7317 DBInstanceClass?: String;
7318 /**
7319 * The port number on which the database accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB instance.
7320 */
7321 Port?: IntegerOptional;
7322 /**
7323 * The Availability Zone (AZ) where the DB instance will be created. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example: us-east-1a
7324 */
7325 AvailabilityZone?: String;
7326 /**
7327 * The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
7328 */
7329 DBSubnetGroupName?: String;
7330 /**
7331 * A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
7332 */
7333 MultiAZ?: BooleanOptional;
7334 /**
7335 * A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
7336 */
7337 PubliclyAccessible?: BooleanOptional;
7338 /**
7339 * A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
7340 */
7341 AutoMinorVersionUpgrade?: BooleanOptional;
7342 /**
7343 * License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
7344 */
7345 LicenseModel?: String;
7346 /**
7347 * The database name for the restored DB instance. This parameter isn't used for the MySQL or MariaDB engines.
7348 */
7349 DBName?: String;
7350 /**
7351 * 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
7352 */
7353 Engine?: String;
7354 /**
7355 * 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 isn't supported.
7356 */
7357 Iops?: IntegerOptional;
7358 /**
7359 * 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
7360 */
7361 OptionGroupName?: String;
7362 /**
7363 * A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
7364 */
7365 CopyTagsToSnapshot?: BooleanOptional;
7366 Tags?: TagList;
7367 /**
7368 * 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 gp2
7369 */
7370 StorageType?: String;
7371 /**
7372 * The ARN from the key store with which to associate the instance for TDE encryption.
7373 */
7374 TdeCredentialArn?: String;
7375 /**
7376 * The password for the given ARN from the key store in order to access the device.
7377 */
7378 TdeCredentialPassword?: String;
7379 /**
7380 * 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.
7381 */
7382 VpcSecurityGroupIds?: VpcSecurityGroupIdList;
7383 /**
7384 * Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain. For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide. For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
7385 */
7386 Domain?: String;
7387 /**
7388 * Specify the name of the IAM role to be used when making API calls to the Directory Service.
7389 */
7390 DomainIAMRoleName?: String;
7391 /**
7392 * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
7393 */
7394 EnableIAMDatabaseAuthentication?: BooleanOptional;
7395 /**
7396 * 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.
7397 */
7398 EnableCloudwatchLogsExports?: LogTypeList;
7399 /**
7400 * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
7401 */
7402 ProcessorFeatures?: ProcessorFeatureList;
7403 /**
7404 * A value that indicates whether the DB instance class of the DB instance uses its default processor features.
7405 */
7406 UseDefaultProcessorFeatures?: BooleanOptional;
7407 /**
7408 * The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB 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.
7409 */
7410 DBParameterGroupName?: String;
7411 /**
7412 * A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
7413 */
7414 DeletionProtection?: BooleanOptional;
7415 /**
7416 * The resource ID of the source DB instance from which to restore.
7417 */
7418 SourceDbiResourceId?: String;
7419 }
7420 export interface RestoreDBInstanceToPointInTimeResult {
7421 DBInstance?: DBInstance;
7422 }
7423 export interface RestoreWindow {
7424 /**
7425 * The earliest time you can restore an instance to.
7426 */
7427 EarliestTime?: TStamp;
7428 /**
7429 * The latest time you can restore an instance to.
7430 */
7431 LatestTime?: TStamp;
7432 }
7433 export interface RevokeDBSecurityGroupIngressMessage {
7434 /**
7435 * The name of the DB security group to revoke ingress from.
7436 */
7437 DBSecurityGroupName: String;
7438 /**
7439 * 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.
7440 */
7441 CIDRIP?: String;
7442 /**
7443 * 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.
7444 */
7445 EC2SecurityGroupName?: String;
7446 /**
7447 * 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.
7448 */
7449 EC2SecurityGroupId?: String;
7450 /**
7451 * The AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
7452 */
7453 EC2SecurityGroupOwnerId?: String;
7454 }
7455 export interface RevokeDBSecurityGroupIngressResult {
7456 DBSecurityGroup?: DBSecurityGroup;
7457 }
7458 export interface ScalingConfiguration {
7459 /**
7460 * The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.
7461 */
7462 MinCapacity?: IntegerOptional;
7463 /**
7464 * The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.
7465 */
7466 MaxCapacity?: IntegerOptional;
7467 /**
7468 * A value that indicates 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.
7469 */
7470 AutoPause?: BooleanOptional;
7471 /**
7472 * The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
7473 */
7474 SecondsUntilAutoPause?: IntegerOptional;
7475 /**
7476 * The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
7477 */
7478 TimeoutAction?: String;
7479 }
7480 export interface ScalingConfigurationInfo {
7481 /**
7482 * The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
7483 */
7484 MinCapacity?: IntegerOptional;
7485 /**
7486 * The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
7487 */
7488 MaxCapacity?: IntegerOptional;
7489 /**
7490 * A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode. When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.
7491 */
7492 AutoPause?: BooleanOptional;
7493 /**
7494 * 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).
7495 */
7496 SecondsUntilAutoPause?: IntegerOptional;
7497 /**
7498 * The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
7499 */
7500 TimeoutAction?: String;
7501 }
7502 export type SourceIdsList = String[];
7503 export interface SourceRegion {
7504 /**
7505 * The name of the source AWS Region.
7506 */
7507 RegionName?: String;
7508 /**
7509 * The endpoint for the source AWS Region endpoint.
7510 */
7511 Endpoint?: String;
7512 /**
7513 * The status of the source AWS Region.
7514 */
7515 Status?: String;
7516 }
7517 export type SourceRegionList = SourceRegion[];
7518 export interface SourceRegionMessage {
7519 /**
7520 * 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.
7521 */
7522 Marker?: String;
7523 /**
7524 * 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.
7525 */
7526 SourceRegions?: SourceRegionList;
7527 }
7528 export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
7529 export interface StartActivityStreamRequest {
7530 /**
7531 * The Amazon Resource Name (ARN) of the DB cluster, for example arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
7532 */
7533 ResourceArn: String;
7534 /**
7535 * Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
7536 */
7537 Mode: ActivityStreamMode;
7538 /**
7539 * The AWS KMS key identifier for encrypting messages in the database activity stream. The key identifier can be either a key ID, a key ARN, or a key alias.
7540 */
7541 KmsKeyId: String;
7542 /**
7543 * Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
7544 */
7545 ApplyImmediately?: BooleanOptional;
7546 }
7547 export interface StartActivityStreamResponse {
7548 /**
7549 * The AWS KMS key identifier for encryption of messages in the database activity stream.
7550 */
7551 KmsKeyId?: String;
7552 /**
7553 * The name of the Amazon Kinesis data stream to be used for the database activity stream.
7554 */
7555 KinesisStreamName?: String;
7556 /**
7557 * The status of the database activity stream.
7558 */
7559 Status?: ActivityStreamStatus;
7560 /**
7561 * The mode of the database activity stream.
7562 */
7563 Mode?: ActivityStreamMode;
7564 /**
7565 * Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
7566 */
7567 ApplyImmediately?: Boolean;
7568 }
7569 export interface StartDBClusterMessage {
7570 /**
7571 * The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
7572 */
7573 DBClusterIdentifier: String;
7574 }
7575 export interface StartDBClusterResult {
7576 DBCluster?: DBCluster;
7577 }
7578 export interface StartDBInstanceMessage {
7579 /**
7580 * The user-supplied instance identifier.
7581 */
7582 DBInstanceIdentifier: String;
7583 }
7584 export interface StartDBInstanceResult {
7585 DBInstance?: DBInstance;
7586 }
7587 export interface StartExportTaskMessage {
7588 /**
7589 * A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.
7590 */
7591 ExportTaskIdentifier: String;
7592 /**
7593 * The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
7594 */
7595 SourceArn: String;
7596 /**
7597 * The name of the Amazon S3 bucket to export the snapshot to.
7598 */
7599 S3BucketName: String;
7600 /**
7601 * The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.
7602 */
7603 IamRoleArn: String;
7604 /**
7605 * The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
7606 */
7607 KmsKeyId: String;
7608 /**
7609 * The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
7610 */
7611 S3Prefix?: String;
7612 /**
7613 * The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following: database - Export all the data of the snapshot. database.table [table-name] - Export a table of the snapshot. database.schema [schema-name] - Export a database schema of the snapshot. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL. database.schema.table [table-name] - Export a table of the database schema. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.
7614 */
7615 ExportOnly?: StringList;
7616 }
7617 export interface StopActivityStreamRequest {
7618 /**
7619 * The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
7620 */
7621 ResourceArn: String;
7622 /**
7623 * Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
7624 */
7625 ApplyImmediately?: BooleanOptional;
7626 }
7627 export interface StopActivityStreamResponse {
7628 /**
7629 * The AWS KMS key identifier used for encrypting messages in the database activity stream.
7630 */
7631 KmsKeyId?: String;
7632 /**
7633 * The name of the Amazon Kinesis data stream used for the database activity stream.
7634 */
7635 KinesisStreamName?: String;
7636 /**
7637 * The status of the database activity stream.
7638 */
7639 Status?: ActivityStreamStatus;
7640 }
7641 export interface StopDBClusterMessage {
7642 /**
7643 * The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
7644 */
7645 DBClusterIdentifier: String;
7646 }
7647 export interface StopDBClusterResult {
7648 DBCluster?: DBCluster;
7649 }
7650 export interface StopDBInstanceMessage {
7651 /**
7652 * The user-supplied instance identifier.
7653 */
7654 DBInstanceIdentifier: String;
7655 /**
7656 * The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
7657 */
7658 DBSnapshotIdentifier?: String;
7659 }
7660 export interface StopDBInstanceResult {
7661 DBInstance?: DBInstance;
7662 }
7663 export type String = string;
7664 export type StringList = String[];
7665 export type StringSensitive = string;
7666 export interface Subnet {
7667 /**
7668 * Specifies the identifier of the subnet.
7669 */
7670 SubnetIdentifier?: String;
7671 SubnetAvailabilityZone?: AvailabilityZone;
7672 /**
7673 * Specifies the status of the subnet.
7674 */
7675 SubnetStatus?: String;
7676 }
7677 export type SubnetIdentifierList = String[];
7678 export type SubnetList = Subnet[];
7679 export type SupportedCharacterSetsList = CharacterSet[];
7680 export type SupportedTimezonesList = Timezone[];
7681 export type TStamp = Date;
7682 export interface Tag {
7683 /**
7684 * 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}_.:/=+\\-]*)$").
7685 */
7686 Key?: String;
7687 /**
7688 * 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}_.:/=+\\-]*)$").
7689 */
7690 Value?: String;
7691 }
7692 export type TagList = Tag[];
7693 export interface TagListMessage {
7694 /**
7695 * List of tags returned by the ListTagsForResource operation.
7696 */
7697 TagList?: TagList;
7698 }
7699 export type TargetGroupList = DBProxyTargetGroup[];
7700 export type TargetList = DBProxyTarget[];
7701 export type TargetType = "RDS_INSTANCE"|"RDS_SERVERLESS_ENDPOINT"|"TRACKED_CLUSTER"|string;
7702 export interface Timezone {
7703 /**
7704 * The name of the time zone.
7705 */
7706 TimezoneName?: String;
7707 }
7708 export interface UpgradeTarget {
7709 /**
7710 * The name of the upgrade target database engine.
7711 */
7712 Engine?: String;
7713 /**
7714 * The version number of the upgrade target database engine.
7715 */
7716 EngineVersion?: String;
7717 /**
7718 * The version of the database engine that a DB instance can be upgraded to.
7719 */
7720 Description?: String;
7721 /**
7722 * A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
7723 */
7724 AutoUpgrade?: Boolean;
7725 /**
7726 * A value that indicates whether a database engine is upgraded to a major version.
7727 */
7728 IsMajorVersionUpgrade?: Boolean;
7729 }
7730 export interface UserAuthConfig {
7731 /**
7732 * A user-specified description about the authentication used by a proxy to log in as a specific database user.
7733 */
7734 Description?: String;
7735 /**
7736 * The name of the database user to which the proxy connects.
7737 */
7738 UserName?: String;
7739 /**
7740 * The type of authentication that the proxy uses for connections from the proxy to the underlying database.
7741 */
7742 AuthScheme?: AuthScheme;
7743 /**
7744 * The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
7745 */
7746 SecretArn?: String;
7747 /**
7748 * Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
7749 */
7750 IAMAuth?: IAMAuthMode;
7751 }
7752 export interface UserAuthConfigInfo {
7753 /**
7754 * A user-specified description about the authentication used by a proxy to log in as a specific database user.
7755 */
7756 Description?: String;
7757 /**
7758 * The name of the database user to which the proxy connects.
7759 */
7760 UserName?: String;
7761 /**
7762 * The type of authentication that the proxy uses for connections from the proxy to the underlying database.
7763 */
7764 AuthScheme?: AuthScheme;
7765 /**
7766 * The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
7767 */
7768 SecretArn?: String;
7769 /**
7770 * Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
7771 */
7772 IAMAuth?: IAMAuthMode;
7773 }
7774 export type UserAuthConfigInfoList = UserAuthConfigInfo[];
7775 export type UserAuthConfigList = UserAuthConfig[];
7776 export interface ValidDBInstanceModificationsMessage {
7777 /**
7778 * Valid storage options for your DB instance.
7779 */
7780 Storage?: ValidStorageOptionsList;
7781 /**
7782 * Valid processor features for your DB instance.
7783 */
7784 ValidProcessorFeatures?: AvailableProcessorFeatureList;
7785 }
7786 export interface ValidStorageOptions {
7787 /**
7788 * The valid storage types for your DB instance. For example, gp2, io1.
7789 */
7790 StorageType?: String;
7791 /**
7792 * The valid range of storage in gibibytes. For example, 100 to 16384.
7793 */
7794 StorageSize?: RangeList;
7795 /**
7796 * The valid range of provisioned IOPS. For example, 1000-20000.
7797 */
7798 ProvisionedIops?: RangeList;
7799 /**
7800 * 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.
7801 */
7802 IopsToStorageRatio?: DoubleRangeList;
7803 /**
7804 * Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
7805 */
7806 SupportsStorageAutoscaling?: Boolean;
7807 }
7808 export type ValidStorageOptionsList = ValidStorageOptions[];
7809 export type ValidUpgradeTargetList = UpgradeTarget[];
7810 export type VpcSecurityGroupIdList = String[];
7811 export interface VpcSecurityGroupMembership {
7812 /**
7813 * The name of the VPC security group.
7814 */
7815 VpcSecurityGroupId?: String;
7816 /**
7817 * The status of the VPC security group.
7818 */
7819 Status?: String;
7820 }
7821 export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
7822 export interface VpnDetails {
7823 /**
7824 * The ID of the VPN.
7825 */
7826 VpnId?: String;
7827 /**
7828 * The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
7829 */
7830 VpnTunnelOriginatorIP?: String;
7831 /**
7832 * The IP address of network traffic from AWS to your on-premises data center.
7833 */
7834 VpnGatewayIp?: String;
7835 /**
7836 * The preshared key (PSK) for the VPN.
7837 */
7838 VpnPSK?: StringSensitive;
7839 /**
7840 * The name of the VPN.
7841 */
7842 VpnName?: String;
7843 /**
7844 * The state of the VPN.
7845 */
7846 VpnState?: String;
7847 }
7848 /**
7849 * 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.
7850 */
7851 export type apiVersion = "2013-01-10"|"2013-02-12"|"2013-09-09"|"2014-09-01"|"2014-09-01"|"2014-10-31"|"latest"|string;
7852 export interface ClientApiVersions {
7853 /**
7854 * 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.
7855 */
7856 apiVersion?: apiVersion;
7857 }
7858 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
7859 /**
7860 * Contains interfaces for use with the RDS client.
7861 */
7862 export import Types = RDS;
7863}
7864export = RDS;