aws-sdk 2.1403.0 → 2.1404.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -1
- package/README.md +1 -1
- package/apis/devops-guru-2020-12-01.min.json +49 -33
- package/clients/devopsguru.d.ts +41 -3
- package/clients/fsx.d.ts +9 -3
- package/clients/rds.d.ts +289 -289
- package/clients/verifiedpermissions.d.ts +6 -6
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +2 -2
- package/dist/aws-sdk.js +3 -3
- package/dist/aws-sdk.min.js +2 -2
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/rds.d.ts
CHANGED
@@ -470,11 +470,11 @@ declare class RDS extends Service {
|
|
470
470
|
*/
|
471
471
|
describeDBClusterSnapshots(callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
|
472
472
|
/**
|
473
|
-
*
|
473
|
+
* Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
|
474
474
|
*/
|
475
475
|
describeDBClusters(params: RDS.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
|
476
476
|
/**
|
477
|
-
*
|
477
|
+
* Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
|
478
478
|
*/
|
479
479
|
describeDBClusters(callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
|
480
480
|
/**
|
@@ -494,11 +494,11 @@ declare class RDS extends Service {
|
|
494
494
|
*/
|
495
495
|
describeDBInstanceAutomatedBackups(callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request<RDS.Types.DBInstanceAutomatedBackupMessage, AWSError>;
|
496
496
|
/**
|
497
|
-
*
|
497
|
+
* Describes provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
|
498
498
|
*/
|
499
499
|
describeDBInstances(params: RDS.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
|
500
500
|
/**
|
501
|
-
*
|
501
|
+
* Describes provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
|
502
502
|
*/
|
503
503
|
describeDBInstances(callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
|
504
504
|
/**
|
@@ -774,11 +774,11 @@ declare class RDS extends Service {
|
|
774
774
|
*/
|
775
775
|
modifyCustomDBEngineVersion(callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
776
776
|
/**
|
777
|
-
*
|
777
|
+
* Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
|
778
778
|
*/
|
779
779
|
modifyDBCluster(params: RDS.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
|
780
780
|
/**
|
781
|
-
*
|
781
|
+
* Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
|
782
782
|
*/
|
783
783
|
modifyDBCluster(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
|
784
784
|
/**
|
@@ -1819,184 +1819,184 @@ declare namespace RDS {
|
|
1819
1819
|
}
|
1820
1820
|
export interface CreateDBClusterMessage {
|
1821
1821
|
/**
|
1822
|
-
* A list of Availability Zones (AZs) where DB instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
1822
|
+
* A list of Availability Zones (AZs) where DB instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
|
1823
1823
|
*/
|
1824
1824
|
AvailabilityZones?: AvailabilityZones;
|
1825
1825
|
/**
|
1826
|
-
* The number of days for which automated backups are retained. Default: 1
|
1826
|
+
* The number of days for which automated backups are retained. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Default: 1 Constraints: Must be a value from 1 to 35.
|
1827
1827
|
*/
|
1828
1828
|
BackupRetentionPeriod?: IntegerOptional;
|
1829
1829
|
/**
|
1830
|
-
*
|
1830
|
+
* The name of the character set (CharacterSet) to associate the DB cluster with. Valid for Cluster Type: Aurora DB clusters only
|
1831
1831
|
*/
|
1832
1832
|
CharacterSetName?: String;
|
1833
1833
|
/**
|
1834
|
-
* The name for your database of up to 64 alphanumeric characters. If you
|
1834
|
+
* The name for your database of up to 64 alphanumeric characters. If you don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1835
1835
|
*/
|
1836
1836
|
DatabaseName?: String;
|
1837
1837
|
/**
|
1838
|
-
* The DB cluster
|
1838
|
+
* The identifier for this DB cluster. This parameter is stored as a lowercase string. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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
|
1839
1839
|
*/
|
1840
1840
|
DBClusterIdentifier: String;
|
1841
1841
|
/**
|
1842
|
-
* The name of the DB cluster parameter group to associate with this DB cluster. If you
|
1842
|
+
* The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: If supplied, must match the name of an existing DB cluster parameter group.
|
1843
1843
|
*/
|
1844
1844
|
DBClusterParameterGroupName?: String;
|
1845
1845
|
/**
|
1846
|
-
* A list of EC2 VPC security groups to associate with this DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1846
|
+
* A list of EC2 VPC security groups to associate with this DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1847
1847
|
*/
|
1848
1848
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
1849
1849
|
/**
|
1850
|
-
* A DB subnet group to associate with this DB cluster. This setting is required to create a Multi-AZ DB cluster. Constraints:
|
1850
|
+
* A DB subnet group to associate with this DB cluster. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must match the name of an existing DB subnet group. Must not be default. Example: mydbsubnetgroup
|
1851
1851
|
*/
|
1852
1852
|
DBSubnetGroupName?: String;
|
1853
1853
|
/**
|
1854
|
-
* The
|
1854
|
+
* The database engine to use for this DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres
|
1855
1855
|
*/
|
1856
1856
|
Engine: String;
|
1857
1857
|
/**
|
1858
|
-
* The version number of the database engine to use. To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively. 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" To list all of the available engine versions for RDS for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
|
1858
|
+
* The version number of the database engine to use. To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively. 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" To list all of the available engine versions for RDS for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" For information about a specific engine, see the following topics: Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide. Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide. RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide. RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1859
1859
|
*/
|
1860
1860
|
EngineVersion?: String;
|
1861
1861
|
/**
|
1862
|
-
* The port number on which the instances in the DB cluster accept connections.
|
1862
|
+
* The port number on which the instances in the DB cluster accept connections. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: 1150-65535 Default: RDS for MySQL and Aurora MySQL - 3306 RDS for PostgreSQL and Aurora PostgreSQL - 5432
|
1863
1863
|
*/
|
1864
1864
|
Port?: IntegerOptional;
|
1865
1865
|
/**
|
1866
|
-
* 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.
|
1866
|
+
* The name of the master user for the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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.
|
1867
1867
|
*/
|
1868
1868
|
MasterUsername?: String;
|
1869
1869
|
/**
|
1870
|
-
* The password for the master database user.
|
1870
|
+
* The password for the master database user. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must contain from 8 to 41 characters. Can contain any printable ASCII character except "/", """, or "@". Can't be specified if ManageMasterUserPassword is turned on.
|
1871
1871
|
*/
|
1872
1872
|
MasterUserPassword?: String;
|
1873
1873
|
/**
|
1874
|
-
*
|
1874
|
+
* The option group to associate the DB cluster with. DB clusters are associated with a default option group that can't be modified.
|
1875
1875
|
*/
|
1876
1876
|
OptionGroupName?: String;
|
1877
1877
|
/**
|
1878
|
-
* 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 Amazon Web Services Region. To view the time blocks available, see Backup 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.
|
1878
|
+
* The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup 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.
|
1879
1879
|
*/
|
1880
1880
|
PreferredBackupWindow?: String;
|
1881
1881
|
/**
|
1882
|
-
* The weekly time range during which system maintenance can occur
|
1882
|
+
* The weekly time range during which system maintenance can occur. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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. Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun. Must be in Universal Coordinated Time (UTC). Must be at least 30 minutes.
|
1883
1883
|
*/
|
1884
1884
|
PreferredMaintenanceWindow?: String;
|
1885
1885
|
/**
|
1886
|
-
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1886
|
+
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1887
1887
|
*/
|
1888
1888
|
ReplicationSourceIdentifier?: String;
|
1889
1889
|
/**
|
1890
|
-
* Tags to assign to the DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1890
|
+
* Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1891
1891
|
*/
|
1892
1892
|
Tags?: TagList;
|
1893
1893
|
/**
|
1894
|
-
*
|
1894
|
+
* Specifies whether the DB cluster is encrypted. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1895
1895
|
*/
|
1896
1896
|
StorageEncrypted?: BooleanOptional;
|
1897
1897
|
/**
|
1898
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When a KMS key isn't specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS
|
1898
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When a KMS key isn't specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key. If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1899
1899
|
*/
|
1900
1900
|
KmsKeyId?: String;
|
1901
1901
|
/**
|
1902
|
-
* When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster. The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy. The presigned URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL. DestinationRegion - The name of the Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region. Valid for: Aurora DB clusters onlyIf you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
1902
|
+
* When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster. The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy. The presigned URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL. DestinationRegion - The name of the Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region. Valid for Cluster Type: Aurora DB clusters onlyIf you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
1903
1903
|
*/
|
1904
1904
|
PreSignedUrl?: String;
|
1905
1905
|
/**
|
1906
|
-
*
|
1906
|
+
* Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
|
1907
1907
|
*/
|
1908
1908
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
1909
1909
|
/**
|
1910
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0
|
1910
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Valid for Cluster Type: Aurora MySQL DB clusters only Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
1911
1911
|
*/
|
1912
1912
|
BacktrackWindow?: LongOptional;
|
1913
1913
|
/**
|
1914
|
-
* The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
1914
|
+
* The list of log types that need to be enabled for exporting to CloudWatch Logs. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The following values are valid for each DB engine: Aurora MySQL - audit | error | general | slowquery Aurora PostgreSQL - postgresql RDS for MySQL - error | general | slowquery RDS for PostgreSQL - postgresql | upgrade For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
|
1915
1915
|
*/
|
1916
1916
|
EnableCloudwatchLogsExports?: LogTypeList;
|
1917
1917
|
/**
|
1918
|
-
* The DB engine mode of the DB cluster, either provisioned or serverless. The serverless engine mode only applies for Aurora Serverless v1 DB clusters. For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless v1 Requirements for Aurora Serverless v2 Valid for: Aurora DB clusters only
|
1918
|
+
* The DB engine mode of the DB cluster, either provisioned or serverless. The serverless engine mode only applies for Aurora Serverless v1 DB clusters. For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless v1 Requirements for Aurora Serverless v2 Valid for Cluster Type: Aurora DB clusters only
|
1919
1919
|
*/
|
1920
1920
|
EngineMode?: String;
|
1921
1921
|
/**
|
1922
|
-
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. Valid for: Aurora DB clusters only
|
1922
|
+
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster. Valid for Cluster Type: Aurora DB clusters only
|
1923
1923
|
*/
|
1924
1924
|
ScalingConfiguration?: ScalingConfiguration;
|
1925
1925
|
/**
|
1926
|
-
*
|
1926
|
+
* Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1927
1927
|
*/
|
1928
1928
|
DeletionProtection?: BooleanOptional;
|
1929
1929
|
/**
|
1930
|
-
* The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. Valid for: Aurora DB clusters only
|
1930
|
+
* The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. Valid for Cluster Type: Aurora DB clusters only
|
1931
1931
|
*/
|
1932
1932
|
GlobalClusterIdentifier?: String;
|
1933
1933
|
/**
|
1934
|
-
*
|
1934
|
+
* Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
|
1935
1935
|
*/
|
1936
1936
|
EnableHttpEndpoint?: BooleanOptional;
|
1937
1937
|
/**
|
1938
|
-
*
|
1938
|
+
* Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
1939
1939
|
*/
|
1940
1940
|
CopyTagsToSnapshot?: BooleanOptional;
|
1941
1941
|
/**
|
1942
|
-
* 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 Kerberos authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
1942
|
+
* 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 Kerberos authentication in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
|
1943
1943
|
*/
|
1944
1944
|
Domain?: String;
|
1945
1945
|
/**
|
1946
|
-
*
|
1946
|
+
* The name of the IAM role to use when making API calls to the Directory Service. Valid for Cluster Type: Aurora DB clusters only
|
1947
1947
|
*/
|
1948
1948
|
DomainIAMRoleName?: String;
|
1949
1949
|
/**
|
1950
|
-
*
|
1950
|
+
* Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. Valid for Cluster Type: Aurora DB clusters only
|
1951
1951
|
*/
|
1952
1952
|
EnableGlobalWriteForwarding?: BooleanOptional;
|
1953
1953
|
/**
|
1954
|
-
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services 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. This setting is required to create a Multi-AZ DB cluster. Valid for: Multi-AZ DB clusters only
|
1954
|
+
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services 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. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only
|
1955
1955
|
*/
|
1956
1956
|
DBClusterInstanceClass?: String;
|
1957
1957
|
/**
|
1958
|
-
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. This setting is required to create a Multi-AZ DB cluster.
|
1958
|
+
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only This setting is required to create a Multi-AZ DB cluster.
|
1959
1959
|
*/
|
1960
1960
|
AllocatedStorage?: IntegerOptional;
|
1961
1961
|
/**
|
1962
|
-
*
|
1962
|
+
* The storage type to associate with the DB cluster. For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters. This setting is required to create a Multi-AZ DB cluster. When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: Aurora DB clusters - aurora | aurora-iopt1 Multi-AZ DB clusters - io1 Default: Aurora DB clusters - aurora Multi-AZ DB clusters - io1
|
1963
1963
|
*/
|
1964
1964
|
StorageType?: String;
|
1965
1965
|
/**
|
1966
|
-
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB cluster. Constraints:
|
1966
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
|
1967
1967
|
*/
|
1968
1968
|
Iops?: IntegerOptional;
|
1969
1969
|
/**
|
1970
|
-
*
|
1970
|
+
* Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Valid for Cluster Type: Multi-AZ DB clusters only 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 cluster is private. If the default VPC in the target Region has an internet gateway attached to it, the DB cluster 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 cluster is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
|
1971
1971
|
*/
|
1972
1972
|
PubliclyAccessible?: BooleanOptional;
|
1973
1973
|
/**
|
1974
|
-
*
|
1974
|
+
* Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only
|
1975
1975
|
*/
|
1976
1976
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
1977
1977
|
/**
|
1978
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
|
1978
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
|
1979
1979
|
*/
|
1980
1980
|
MonitoringInterval?: IntegerOptional;
|
1981
1981
|
/**
|
1982
|
-
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is 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, supply a MonitoringRoleArn value. Valid for: Multi-AZ DB clusters only
|
1982
|
+
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is 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, supply a MonitoringRoleArn value. Valid for Cluster Type: Multi-AZ DB clusters only
|
1983
1983
|
*/
|
1984
1984
|
MonitoringRoleArn?: String;
|
1985
1985
|
/**
|
1986
|
-
*
|
1986
|
+
* Specifies whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only
|
1987
1987
|
*/
|
1988
1988
|
EnablePerformanceInsights?: BooleanOptional;
|
1989
1989
|
/**
|
1990
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for: Multi-AZ DB clusters only
|
1990
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for Cluster Type: Multi-AZ DB clusters only
|
1991
1991
|
*/
|
1992
1992
|
PerformanceInsightsKMSKeyId?: String;
|
1993
1993
|
/**
|
1994
|
-
* The number of days to retain Performance Insights data.
|
1994
|
+
* The number of days to retain Performance Insights data. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 7 month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
|
1995
1995
|
*/
|
1996
1996
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
1997
1997
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
1998
1998
|
/**
|
1999
|
-
* The network type of the DB cluster.
|
1999
|
+
* The network type of the DB cluster. The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only Valid Values: IPV4 | DUAL
|
2000
2000
|
*/
|
2001
2001
|
NetworkType?: String;
|
2002
2002
|
/**
|
@@ -2004,11 +2004,11 @@ declare namespace RDS {
|
|
2004
2004
|
*/
|
2005
2005
|
DBSystemId?: String;
|
2006
2006
|
/**
|
2007
|
-
*
|
2007
|
+
* Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
|
2008
2008
|
*/
|
2009
2009
|
ManageMasterUserPassword?: BooleanOptional;
|
2010
2010
|
/**
|
2011
|
-
* The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2011
|
+
* The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
2012
2012
|
*/
|
2013
2013
|
MasterUserSecretKmsKeyId?: String;
|
2014
2014
|
/**
|
@@ -2059,15 +2059,15 @@ declare namespace RDS {
|
|
2059
2059
|
}
|
2060
2060
|
export interface CreateDBInstanceMessage {
|
2061
2061
|
/**
|
2062
|
-
* The meaning of this parameter differs
|
2062
|
+
* The meaning of this parameter differs depending on the database engine. Amazon Aurora MySQL Amazon Aurora PostgreSQL Amazon RDS Custom for Oracle Amazon RDS Custom for SQL Server RDS for MariaDB RDS for MySQL RDS for Oracle RDS for PostgreSQL RDS for SQL Server The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB cluster. Constraints: Must contain 1 to 64 alphanumeric characters. Can't be a word reserved by the database engine. The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. Default: postgres Constraints: Must contain 1 to 63 alphanumeric characters. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9). Can't be a word reserved by the database engine. The Oracle System ID (SID) of the created RDS Custom DB instance. Default: ORCL Constraints: Must contain 1 to 8 alphanumeric characters. Must contain a letter. Can't be a word reserved by the database engine. Not applicable. Must be null. The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the database engine. The name of the database to create when the DB instance is created. If you don't specify a value, Amazon RDS doesn't create a database in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the database engine. The Oracle System ID (SID) of the created DB instance. Default: ORCL Constraints: Can't be longer than 8 characters. Can't be a word reserved by the database engine, such as the string NULL. The name of the database to create when the DB instance is created. Default: postgres Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the database engine. Not applicable. Must be null.
|
2063
2063
|
*/
|
2064
2064
|
DBName?: String;
|
2065
2065
|
/**
|
2066
|
-
* The DB instance
|
2066
|
+
* The identifier for this DB instance. 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
|
2067
2067
|
*/
|
2068
2068
|
DBInstanceIdentifier: String;
|
2069
2069
|
/**
|
2070
|
-
* The amount of storage in gibibytes (GiB) to allocate for the DB instance.
|
2070
|
+
* The amount of storage in gibibytes (GiB) to allocate for the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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. Amazon RDS Custom RDS for MariaDB RDS for MySQL RDS for Oracle RDS for PostgreSQL RDS for SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2, gp3): 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. Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2, gp3): 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. Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2, gp3): 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. Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2, gp3): 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. Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2, gp3): Enterprise and Standard editions: Must be an integer from 20 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 100 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 20 to 1024. Web and Express editions: Must be an integer from 20 to 1024.
|
2071
2071
|
*/
|
2072
2072
|
AllocatedStorage?: IntegerOptional;
|
2073
2073
|
/**
|
@@ -2075,15 +2075,15 @@ declare namespace RDS {
|
|
2075
2075
|
*/
|
2076
2076
|
DBInstanceClass: String;
|
2077
2077
|
/**
|
2078
|
-
* The
|
2078
|
+
* The database engine to use for this DB instance. Not every database engine is available in every Amazon Web Services Region. Valid Values: aurora-mysql (for Aurora MySQL DB instances) aurora-postgresql (for Aurora PostgreSQL DB instances) custom-oracle-ee (for RDS Custom for Oracle DB instances) custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances) custom-sqlserver-ee (for RDS Custom for SQL Server DB instances) custom-sqlserver-se (for RDS Custom for SQL Server DB instances) custom-sqlserver-web (for RDS Custom for SQL Server DB instances) mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
2079
2079
|
*/
|
2080
2080
|
Engine: String;
|
2081
2081
|
/**
|
2082
|
-
* The name for the master user.
|
2082
|
+
* The name for the master user. This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster. This setting is required for RDS DB instances. Constraints: Must be 1 to 16 letters, numbers, or underscores. First character must be a letter. Can't be a reserved word for the chosen database engine.
|
2083
2083
|
*/
|
2084
2084
|
MasterUsername?: String;
|
2085
2085
|
/**
|
2086
|
-
* The password for the master user.
|
2086
|
+
* The password for the master user. This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster. Constraints: Can't be specified if ManageMasterUserPassword is turned on. Can include any printable ASCII character except "/", """, or "@". Length Constraints: RDS for MariaDB - Must contain from 8 to 41 characters. RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. RDS for MySQL - Must contain from 8 to 41 characters. RDS for Oracle - Must contain from 8 to 30 characters. RDS for PostgreSQL - Must contain from 8 to 128 characters.
|
2087
2087
|
*/
|
2088
2088
|
MasterUserPassword?: String;
|
2089
2089
|
/**
|
@@ -2091,71 +2091,71 @@ declare namespace RDS {
|
|
2091
2091
|
*/
|
2092
2092
|
DBSecurityGroups?: DBSecurityGroupNameList;
|
2093
2093
|
/**
|
2094
|
-
* A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
2094
|
+
* A list of Amazon EC2 VPC security groups to associate with this DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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.
|
2095
2095
|
*/
|
2096
2096
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
2097
2097
|
/**
|
2098
|
-
* The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
|
2098
|
+
* The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. Constraints: 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 Amazon Web Services Region as the current endpoint. Example: us-east-1d
|
2099
2099
|
*/
|
2100
2100
|
AvailabilityZone?: String;
|
2101
2101
|
/**
|
2102
|
-
* A DB subnet group to associate with this DB instance. Constraints:
|
2102
|
+
* A DB subnet group to associate with this DB instance. Constraints: Must match the name of an existing DB subnet group. Must not be default. Example: mydbsubnetgroup
|
2103
2103
|
*/
|
2104
2104
|
DBSubnetGroupName?: String;
|
2105
2105
|
/**
|
2106
|
-
* The time range each week during which system maintenance can occur
|
2106
|
+
* The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. The day values must be 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.
|
2107
2107
|
*/
|
2108
2108
|
PreferredMaintenanceWindow?: String;
|
2109
2109
|
/**
|
2110
|
-
* The name of the DB parameter group to associate with this DB instance. If you
|
2110
|
+
* The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version. This setting doesn't apply to RDS Custom DB instances. Constraints: Must be 1 to 255 letters, numbers, or hyphens. The first character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
2111
2111
|
*/
|
2112
2112
|
DBParameterGroupName?: String;
|
2113
2113
|
/**
|
2114
|
-
* 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.
|
2114
|
+
* 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. This setting doesn't apply to Amazon Aurora DB instances. 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. Can't be set to 0 for an RDS Custom for Oracle DB instance.
|
2115
2115
|
*/
|
2116
2116
|
BackupRetentionPeriod?: IntegerOptional;
|
2117
2117
|
/**
|
2118
|
-
* 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 Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
|
2118
|
+
* 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 Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. 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.
|
2119
2119
|
*/
|
2120
2120
|
PreferredBackupWindow?: String;
|
2121
2121
|
/**
|
2122
|
-
* The port number on which the database accepts connections.
|
2122
|
+
* The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: 1150-65535 Default: RDS for MariaDB - 3306 RDS for Microsoft SQL Server - 1433 RDS for MySQL - 3306 RDS for Oracle - 1521 RDS for PostgreSQL - 5432 Constraints: For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
|
2123
2123
|
*/
|
2124
2124
|
Port?: IntegerOptional;
|
2125
2125
|
/**
|
2126
|
-
*
|
2126
|
+
* Specifies 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. This setting doesn't apply to the following DB instances: Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.) RDS Custom
|
2127
2127
|
*/
|
2128
2128
|
MultiAZ?: BooleanOptional;
|
2129
2129
|
/**
|
2130
|
-
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions operation. 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 Amazon Web Services Region. Amazon
|
2130
|
+
* The version number of the database engine to use. This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster. For a list of valid engine versions, use the DescribeDBEngineVersions operation. 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 Amazon Web Services Region. Amazon RDS Custom for Oracle Amazon RDS Custom for SQL Server RDS for MariaDB RDS for Microsoft SQL Server RDS for MySQL RDS for Oracle RDS for PostgreSQL A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide. See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide. For information, see MariaDB on Amazon RDS versions in the Amazon RDS User Guide. For information, see Microsoft SQL Server versions on Amazon RDS in the Amazon RDS User Guide. For information, see MySQL on Amazon RDS versions in the Amazon RDS User Guide. For information, see Oracle Database Engine release notes in the Amazon RDS User Guide. For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
|
2131
2131
|
*/
|
2132
2132
|
EngineVersion?: String;
|
2133
2133
|
/**
|
2134
|
-
*
|
2134
|
+
* Specifies whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
|
2135
2135
|
*/
|
2136
2136
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
2137
2137
|
/**
|
2138
|
-
*
|
2138
|
+
* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license
|
2139
2139
|
*/
|
2140
2140
|
LicenseModel?: String;
|
2141
2141
|
/**
|
2142
|
-
* The amount of Provisioned IOPS (input/output operations per second) to
|
2142
|
+
* The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Constraints: For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
|
2143
2143
|
*/
|
2144
2144
|
Iops?: IntegerOptional;
|
2145
2145
|
/**
|
2146
|
-
*
|
2146
|
+
* The option group to associate the DB instance with. 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 after it is associated with a DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
2147
2147
|
*/
|
2148
2148
|
OptionGroupName?: String;
|
2149
2149
|
/**
|
2150
|
-
* For supported engines,
|
2150
|
+
* For supported engines, the character set (CharacterSet) to associate the DB instance with. This setting doesn't apply to the following DB instances: Amazon Aurora - The character set is managed by the DB cluster. For more information, see CreateDBCluster. RDS Custom - However, if you need to change the character set, you can change it on the database itself.
|
2151
2151
|
*/
|
2152
2152
|
CharacterSetName?: String;
|
2153
2153
|
/**
|
2154
|
-
* The name of the NCHAR character set for the Oracle DB instance. This
|
2154
|
+
* The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
|
2155
2155
|
*/
|
2156
2156
|
NcharCharacterSetName?: String;
|
2157
2157
|
/**
|
2158
|
-
*
|
2158
|
+
* Specifies whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB 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.
|
2159
2159
|
*/
|
2160
2160
|
PubliclyAccessible?: BooleanOptional;
|
2161
2161
|
/**
|
@@ -2163,51 +2163,51 @@ declare namespace RDS {
|
|
2163
2163
|
*/
|
2164
2164
|
Tags?: TagList;
|
2165
2165
|
/**
|
2166
|
-
* The identifier of the DB cluster that
|
2166
|
+
* The identifier of the DB cluster that this DB instance will belong to. This setting doesn't apply to RDS Custom DB instances.
|
2167
2167
|
*/
|
2168
2168
|
DBClusterIdentifier?: String;
|
2169
2169
|
/**
|
2170
|
-
*
|
2170
|
+
* The storage type to associate with the DB instance. If you specify io1 or gp3, you must also include a value for the Iops parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: gp2 | gp3 | io1 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp2.
|
2171
2171
|
*/
|
2172
2172
|
StorageType?: String;
|
2173
2173
|
/**
|
2174
|
-
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom
|
2174
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
2175
2175
|
*/
|
2176
2176
|
TdeCredentialArn?: String;
|
2177
2177
|
/**
|
2178
|
-
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
2178
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom DB instances.
|
2179
2179
|
*/
|
2180
2180
|
TdeCredentialPassword?: String;
|
2181
2181
|
/**
|
2182
|
-
*
|
2182
|
+
* Specifes whether the DB instance is encrypted. By default, it isn't encrypted. For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error. This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster.
|
2183
2183
|
*/
|
2184
2184
|
StorageEncrypted?: BooleanOptional;
|
2185
2185
|
/**
|
2186
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
|
2186
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services 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 uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.
|
2187
2187
|
*/
|
2188
2188
|
KmsKeyId?: String;
|
2189
2189
|
/**
|
2190
|
-
* The Active Directory directory ID to create the DB instance in. Currently, only
|
2190
|
+
* The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: Amazon Aurora (The domain is managed by the DB cluster.) RDS Custom
|
2191
2191
|
*/
|
2192
2192
|
Domain?: String;
|
2193
2193
|
/**
|
2194
|
-
*
|
2194
|
+
* Spcifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. 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.
|
2195
2195
|
*/
|
2196
2196
|
CopyTagsToSnapshot?: BooleanOptional;
|
2197
2197
|
/**
|
2198
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0.
|
2198
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
|
2199
2199
|
*/
|
2200
2200
|
MonitoringInterval?: IntegerOptional;
|
2201
2201
|
/**
|
2202
|
-
* 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. This setting doesn't apply to RDS Custom.
|
2202
|
+
* 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. This setting doesn't apply to RDS Custom DB instances.
|
2203
2203
|
*/
|
2204
2204
|
MonitoringRoleArn?: String;
|
2205
2205
|
/**
|
2206
|
-
*
|
2206
|
+
* The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: Amazon Aurora (The domain is managed by the DB cluster.) RDS Custom
|
2207
2207
|
*/
|
2208
2208
|
DomainIAMRoleName?: String;
|
2209
2209
|
/**
|
2210
|
-
*
|
2210
|
+
* The order of priority 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. This setting doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
|
2211
2211
|
*/
|
2212
2212
|
PromotionTier?: IntegerOptional;
|
2213
2213
|
/**
|
@@ -2215,59 +2215,59 @@ declare namespace RDS {
|
|
2215
2215
|
*/
|
2216
2216
|
Timezone?: String;
|
2217
2217
|
/**
|
2218
|
-
*
|
2218
|
+
* Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: Amazon Aurora (Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.) RDS Custom
|
2219
2219
|
*/
|
2220
2220
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
2221
2221
|
/**
|
2222
|
-
*
|
2222
|
+
* Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
|
2223
2223
|
*/
|
2224
2224
|
EnablePerformanceInsights?: BooleanOptional;
|
2225
2225
|
/**
|
2226
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you
|
2226
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom DB instances.
|
2227
2227
|
*/
|
2228
2228
|
PerformanceInsightsKMSKeyId?: String;
|
2229
2229
|
/**
|
2230
|
-
* The number of days to retain Performance Insights data.
|
2230
|
+
* The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: 7 month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
|
2231
2231
|
*/
|
2232
2232
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
2233
2233
|
/**
|
2234
|
-
* The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
2234
|
+
* The list of log types that need to be enabled for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.) RDS Custom The following values are valid for each DB engine: RDS for MariaDB - audit | error | general | slowquery RDS for Microsoft SQL Server - agent | error RDS for MySQL - audit | error | general | slowquery RDS for Oracle - alert | audit | listener | trace | oemagent RDS for PostgreSQL - postgresql | upgrade
|
2235
2235
|
*/
|
2236
2236
|
EnableCloudwatchLogsExports?: LogTypeList;
|
2237
2237
|
/**
|
2238
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom
|
2238
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
2239
2239
|
*/
|
2240
2240
|
ProcessorFeatures?: ProcessorFeatureList;
|
2241
2241
|
/**
|
2242
|
-
*
|
2242
|
+
* Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance. This setting doesn't apply to Amazon Aurora DB instances. 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.
|
2243
2243
|
*/
|
2244
2244
|
DeletionProtection?: BooleanOptional;
|
2245
2245
|
/**
|
2246
|
-
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to
|
2246
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: Amazon Aurora (Storage is managed by the DB cluster.) RDS Custom
|
2247
2247
|
*/
|
2248
2248
|
MaxAllocatedStorage?: IntegerOptional;
|
2249
2249
|
/**
|
2250
|
-
*
|
2250
|
+
* Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
2251
2251
|
*/
|
2252
2252
|
EnableCustomerOwnedIp?: BooleanOptional;
|
2253
2253
|
/**
|
2254
|
-
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
|
2254
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
|
2255
2255
|
*/
|
2256
2256
|
CustomIamInstanceProfile?: String;
|
2257
2257
|
/**
|
2258
|
-
*
|
2258
|
+
* The location for storing automated backups and manual snapshots. Valie Values: outposts (Amazon Web Services Outposts) region (Amazon Web Services Region) Default: region For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
|
2259
2259
|
*/
|
2260
2260
|
BackupTarget?: String;
|
2261
2261
|
/**
|
2262
|
-
* The network type of the DB instance.
|
2262
|
+
* The network type of the DB instance. The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. Valid Values: IPV4 | DUAL
|
2263
2263
|
*/
|
2264
2264
|
NetworkType?: String;
|
2265
2265
|
/**
|
2266
|
-
*
|
2266
|
+
* The storage throughput value for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
2267
2267
|
*/
|
2268
2268
|
StorageThroughput?: IntegerOptional;
|
2269
2269
|
/**
|
2270
|
-
*
|
2270
|
+
* Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
|
2271
2271
|
*/
|
2272
2272
|
ManageMasterUserPassword?: BooleanOptional;
|
2273
2273
|
/**
|
@@ -2275,7 +2275,7 @@ declare namespace RDS {
|
|
2275
2275
|
*/
|
2276
2276
|
MasterUserSecretKmsKeyId?: String;
|
2277
2277
|
/**
|
2278
|
-
*
|
2278
|
+
* The CA certificate identifier to use for the DB instance's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
|
2279
2279
|
*/
|
2280
2280
|
CACertificateIdentifier?: String;
|
2281
2281
|
}
|
@@ -2698,11 +2698,11 @@ declare namespace RDS {
|
|
2698
2698
|
*/
|
2699
2699
|
AllocatedStorage?: IntegerOptional;
|
2700
2700
|
/**
|
2701
|
-
*
|
2701
|
+
* The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
2702
2702
|
*/
|
2703
2703
|
AvailabilityZones?: AvailabilityZones;
|
2704
2704
|
/**
|
2705
|
-
*
|
2705
|
+
* The number of days for which automatic DB snapshots are retained.
|
2706
2706
|
*/
|
2707
2707
|
BackupRetentionPeriod?: IntegerOptional;
|
2708
2708
|
/**
|
@@ -2710,23 +2710,23 @@ declare namespace RDS {
|
|
2710
2710
|
*/
|
2711
2711
|
CharacterSetName?: String;
|
2712
2712
|
/**
|
2713
|
-
*
|
2713
|
+
* The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
|
2714
2714
|
*/
|
2715
2715
|
DatabaseName?: String;
|
2716
2716
|
/**
|
2717
|
-
*
|
2717
|
+
* The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
|
2718
2718
|
*/
|
2719
2719
|
DBClusterIdentifier?: String;
|
2720
2720
|
/**
|
2721
|
-
*
|
2721
|
+
* The name of the DB cluster parameter group for the DB cluster.
|
2722
2722
|
*/
|
2723
2723
|
DBClusterParameterGroup?: String;
|
2724
2724
|
/**
|
2725
|
-
*
|
2725
|
+
* Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
|
2726
2726
|
*/
|
2727
2727
|
DBSubnetGroup?: String;
|
2728
2728
|
/**
|
2729
|
-
*
|
2729
|
+
* The current state of this DB cluster.
|
2730
2730
|
*/
|
2731
2731
|
Status?: String;
|
2732
2732
|
/**
|
@@ -2734,7 +2734,7 @@ declare namespace RDS {
|
|
2734
2734
|
*/
|
2735
2735
|
AutomaticRestartTime?: TStamp;
|
2736
2736
|
/**
|
2737
|
-
*
|
2737
|
+
* The progress of the operation as a percentage.
|
2738
2738
|
*/
|
2739
2739
|
PercentProgress?: String;
|
2740
2740
|
/**
|
@@ -2742,7 +2742,7 @@ declare namespace RDS {
|
|
2742
2742
|
*/
|
2743
2743
|
EarliestRestorableTime?: TStamp;
|
2744
2744
|
/**
|
2745
|
-
*
|
2745
|
+
* The connection endpoint for the primary instance of the DB cluster.
|
2746
2746
|
*/
|
2747
2747
|
Endpoint?: String;
|
2748
2748
|
/**
|
@@ -2750,47 +2750,47 @@ declare namespace RDS {
|
|
2750
2750
|
*/
|
2751
2751
|
ReaderEndpoint?: String;
|
2752
2752
|
/**
|
2753
|
-
*
|
2753
|
+
* The custom endpoints associated with the DB cluster.
|
2754
2754
|
*/
|
2755
2755
|
CustomEndpoints?: StringList;
|
2756
2756
|
/**
|
2757
|
-
*
|
2757
|
+
* Indicates whether the DB cluster has instances in multiple Availability Zones.
|
2758
2758
|
*/
|
2759
2759
|
MultiAZ?: BooleanOptional;
|
2760
2760
|
/**
|
2761
|
-
* The
|
2761
|
+
* The database engine used for this DB cluster.
|
2762
2762
|
*/
|
2763
2763
|
Engine?: String;
|
2764
2764
|
/**
|
2765
|
-
*
|
2765
|
+
* The version of the database engine.
|
2766
2766
|
*/
|
2767
2767
|
EngineVersion?: String;
|
2768
2768
|
/**
|
2769
|
-
*
|
2769
|
+
* The latest time to which a database can be restored with point-in-time restore.
|
2770
2770
|
*/
|
2771
2771
|
LatestRestorableTime?: TStamp;
|
2772
2772
|
/**
|
2773
|
-
*
|
2773
|
+
* The port that the database engine is listening on.
|
2774
2774
|
*/
|
2775
2775
|
Port?: IntegerOptional;
|
2776
2776
|
/**
|
2777
|
-
*
|
2777
|
+
* The master username for the DB cluster.
|
2778
2778
|
*/
|
2779
2779
|
MasterUsername?: String;
|
2780
2780
|
/**
|
2781
|
-
*
|
2781
|
+
* The list of option group memberships for this DB cluster.
|
2782
2782
|
*/
|
2783
2783
|
DBClusterOptionGroupMemberships?: DBClusterOptionGroupMemberships;
|
2784
2784
|
/**
|
2785
|
-
*
|
2785
|
+
* The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
|
2786
2786
|
*/
|
2787
2787
|
PreferredBackupWindow?: String;
|
2788
2788
|
/**
|
2789
|
-
*
|
2789
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
2790
2790
|
*/
|
2791
2791
|
PreferredMaintenanceWindow?: String;
|
2792
2792
|
/**
|
2793
|
-
*
|
2793
|
+
* The identifier of the source DB cluster if this DB cluster is a read replica.
|
2794
2794
|
*/
|
2795
2795
|
ReplicationSourceIdentifier?: String;
|
2796
2796
|
/**
|
@@ -2798,19 +2798,19 @@ declare namespace RDS {
|
|
2798
2798
|
*/
|
2799
2799
|
ReadReplicaIdentifiers?: ReadReplicaIdentifierList;
|
2800
2800
|
/**
|
2801
|
-
*
|
2801
|
+
* The list of DB instances that make up the DB cluster.
|
2802
2802
|
*/
|
2803
2803
|
DBClusterMembers?: DBClusterMemberList;
|
2804
2804
|
/**
|
2805
|
-
*
|
2805
|
+
* The list of VPC security groups that the DB cluster belongs to.
|
2806
2806
|
*/
|
2807
2807
|
VpcSecurityGroups?: VpcSecurityGroupMembershipList;
|
2808
2808
|
/**
|
2809
|
-
*
|
2809
|
+
* The ID that Amazon Route 53 assigns when you create a hosted zone.
|
2810
2810
|
*/
|
2811
2811
|
HostedZoneId?: String;
|
2812
2812
|
/**
|
2813
|
-
*
|
2813
|
+
* Indicates whether the DB cluster is encrypted.
|
2814
2814
|
*/
|
2815
2815
|
StorageEncrypted?: Boolean;
|
2816
2816
|
/**
|
@@ -2826,19 +2826,19 @@ declare namespace RDS {
|
|
2826
2826
|
*/
|
2827
2827
|
DBClusterArn?: String;
|
2828
2828
|
/**
|
2829
|
-
*
|
2829
|
+
* A list of the Amazon Web Services 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 Amazon Web Services on your behalf.
|
2830
2830
|
*/
|
2831
2831
|
AssociatedRoles?: DBClusterRoles;
|
2832
2832
|
/**
|
2833
|
-
*
|
2833
|
+
* Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
|
2834
2834
|
*/
|
2835
2835
|
IAMDatabaseAuthenticationEnabled?: BooleanOptional;
|
2836
2836
|
/**
|
2837
|
-
*
|
2837
|
+
* The ID of the clone group with which the DB cluster is associated.
|
2838
2838
|
*/
|
2839
2839
|
CloneGroupId?: String;
|
2840
2840
|
/**
|
2841
|
-
*
|
2841
|
+
* The time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
2842
2842
|
*/
|
2843
2843
|
ClusterCreateTime?: TStamp;
|
2844
2844
|
/**
|
@@ -2867,11 +2867,11 @@ declare namespace RDS {
|
|
2867
2867
|
EngineMode?: String;
|
2868
2868
|
ScalingConfigurationInfo?: ScalingConfigurationInfo;
|
2869
2869
|
/**
|
2870
|
-
* Indicates
|
2870
|
+
* Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
|
2871
2871
|
*/
|
2872
2872
|
DeletionProtection?: BooleanOptional;
|
2873
2873
|
/**
|
2874
|
-
*
|
2874
|
+
* Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 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 v1 in the Amazon Aurora User Guide.
|
2875
2875
|
*/
|
2876
2876
|
HttpEndpointEnabled?: BooleanOptional;
|
2877
2877
|
/**
|
@@ -2891,11 +2891,11 @@ declare namespace RDS {
|
|
2891
2891
|
*/
|
2892
2892
|
ActivityStreamKinesisStreamName?: String;
|
2893
2893
|
/**
|
2894
|
-
*
|
2894
|
+
* Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
2895
2895
|
*/
|
2896
2896
|
CopyTagsToSnapshot?: BooleanOptional;
|
2897
2897
|
/**
|
2898
|
-
*
|
2898
|
+
* Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
2899
2899
|
*/
|
2900
2900
|
CrossAccountClone?: BooleanOptional;
|
2901
2901
|
/**
|
@@ -2904,15 +2904,15 @@ declare namespace RDS {
|
|
2904
2904
|
DomainMemberships?: DomainMembershipList;
|
2905
2905
|
TagList?: TagList;
|
2906
2906
|
/**
|
2907
|
-
*
|
2907
|
+
* The status of write forwarding for a secondary cluster in an Aurora global database.
|
2908
2908
|
*/
|
2909
2909
|
GlobalWriteForwardingStatus?: WriteForwardingStatus;
|
2910
2910
|
/**
|
2911
|
-
* Specifies whether
|
2911
|
+
* Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
|
2912
2912
|
*/
|
2913
2913
|
GlobalWriteForwardingRequested?: BooleanOptional;
|
2914
2914
|
/**
|
2915
|
-
*
|
2915
|
+
* Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
|
2916
2916
|
*/
|
2917
2917
|
PendingModifiedValues?: ClusterPendingModifiedValues;
|
2918
2918
|
/**
|
@@ -2928,11 +2928,11 @@ declare namespace RDS {
|
|
2928
2928
|
*/
|
2929
2929
|
Iops?: IntegerOptional;
|
2930
2930
|
/**
|
2931
|
-
*
|
2931
|
+
* Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see CreateDBCluster. This setting is only for non-Aurora Multi-AZ DB clusters.
|
2932
2932
|
*/
|
2933
2933
|
PubliclyAccessible?: BooleanOptional;
|
2934
2934
|
/**
|
2935
|
-
*
|
2935
|
+
* Indicates whether minor version patches are applied automatically. This setting is only for non-Aurora Multi-AZ DB clusters.
|
2936
2936
|
*/
|
2937
2937
|
AutoMinorVersionUpgrade?: Boolean;
|
2938
2938
|
/**
|
@@ -2944,7 +2944,7 @@ declare namespace RDS {
|
|
2944
2944
|
*/
|
2945
2945
|
MonitoringRoleArn?: String;
|
2946
2946
|
/**
|
2947
|
-
*
|
2947
|
+
* Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters.
|
2948
2948
|
*/
|
2949
2949
|
PerformanceInsightsEnabled?: BooleanOptional;
|
2950
2950
|
/**
|
@@ -2952,12 +2952,12 @@ declare namespace RDS {
|
|
2952
2952
|
*/
|
2953
2953
|
PerformanceInsightsKMSKeyId?: String;
|
2954
2954
|
/**
|
2955
|
-
* The number of days to retain Performance Insights data.
|
2955
|
+
* The number of days to retain Performance Insights data. This setting is only for non-Aurora Multi-AZ DB clusters. Valid Values: 7 month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) 731 Default: 7 days
|
2956
2956
|
*/
|
2957
2957
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
2958
2958
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfigurationInfo;
|
2959
2959
|
/**
|
2960
|
-
* The network type of the DB instance.
|
2960
|
+
* The network type of the DB instance. The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide. This setting is only for Aurora DB clusters. Valid Values: IPV4 | DUAL
|
2961
2961
|
*/
|
2962
2962
|
NetworkType?: String;
|
2963
2963
|
/**
|
@@ -2965,7 +2965,7 @@ declare namespace RDS {
|
|
2965
2965
|
*/
|
2966
2966
|
DBSystemId?: String;
|
2967
2967
|
/**
|
2968
|
-
*
|
2968
|
+
* The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
|
2969
2969
|
*/
|
2970
2970
|
MasterUserSecret?: MasterUserSecret;
|
2971
2971
|
/**
|
@@ -3450,19 +3450,19 @@ declare namespace RDS {
|
|
3450
3450
|
}
|
3451
3451
|
export interface DBInstance {
|
3452
3452
|
/**
|
3453
|
-
*
|
3453
|
+
* The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
|
3454
3454
|
*/
|
3455
3455
|
DBInstanceIdentifier?: String;
|
3456
3456
|
/**
|
3457
|
-
*
|
3457
|
+
* The name of the compute and memory capacity class of the DB instance.
|
3458
3458
|
*/
|
3459
3459
|
DBInstanceClass?: String;
|
3460
3460
|
/**
|
3461
|
-
* The
|
3461
|
+
* The database engine used for this DB instance.
|
3462
3462
|
*/
|
3463
3463
|
Engine?: String;
|
3464
3464
|
/**
|
3465
|
-
*
|
3465
|
+
* The current state of this database. For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
|
3466
3466
|
*/
|
3467
3467
|
DBInstanceStatus?: String;
|
3468
3468
|
/**
|
@@ -3470,31 +3470,31 @@ declare namespace RDS {
|
|
3470
3470
|
*/
|
3471
3471
|
AutomaticRestartTime?: TStamp;
|
3472
3472
|
/**
|
3473
|
-
*
|
3473
|
+
* The master username for the DB instance.
|
3474
3474
|
*/
|
3475
3475
|
MasterUsername?: String;
|
3476
3476
|
/**
|
3477
|
-
* The meaning of this parameter differs
|
3477
|
+
* The meaning of this parameter differs depending on the database engine. For RDS for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL - The name of the initial database specified for this DB instance when it was created, if one was provided. This same name is returned for the life of the DB instance. For RDS for Oracle - The Oracle System ID (SID) of the created DB instance. This value is only returned when the object returned is an Oracle DB instance.
|
3478
3478
|
*/
|
3479
3479
|
DBName?: String;
|
3480
3480
|
/**
|
3481
|
-
*
|
3481
|
+
* The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of creating.
|
3482
3482
|
*/
|
3483
3483
|
Endpoint?: Endpoint;
|
3484
3484
|
/**
|
3485
|
-
*
|
3485
|
+
* The amount of storage in gibibytes (GiB) allocated for the DB instance.
|
3486
3486
|
*/
|
3487
3487
|
AllocatedStorage?: Integer;
|
3488
3488
|
/**
|
3489
|
-
*
|
3489
|
+
* The date and time when the DB instance was created.
|
3490
3490
|
*/
|
3491
3491
|
InstanceCreateTime?: TStamp;
|
3492
3492
|
/**
|
3493
|
-
*
|
3493
|
+
* The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
|
3494
3494
|
*/
|
3495
3495
|
PreferredBackupWindow?: String;
|
3496
3496
|
/**
|
3497
|
-
*
|
3497
|
+
* The number of days for which automatic DB snapshots are retained.
|
3498
3498
|
*/
|
3499
3499
|
BackupRetentionPeriod?: Integer;
|
3500
3500
|
/**
|
@@ -3502,55 +3502,55 @@ declare namespace RDS {
|
|
3502
3502
|
*/
|
3503
3503
|
DBSecurityGroups?: DBSecurityGroupMembershipList;
|
3504
3504
|
/**
|
3505
|
-
*
|
3505
|
+
* The list of Amazon EC2 VPC security groups that the DB instance belongs to.
|
3506
3506
|
*/
|
3507
3507
|
VpcSecurityGroups?: VpcSecurityGroupMembershipList;
|
3508
3508
|
/**
|
3509
|
-
*
|
3509
|
+
* The list of DB parameter groups applied to this DB instance.
|
3510
3510
|
*/
|
3511
3511
|
DBParameterGroups?: DBParameterGroupStatusList;
|
3512
3512
|
/**
|
3513
|
-
*
|
3513
|
+
* The name of the Availability Zone where the DB instance is located.
|
3514
3514
|
*/
|
3515
3515
|
AvailabilityZone?: String;
|
3516
3516
|
/**
|
3517
|
-
*
|
3517
|
+
* Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
|
3518
3518
|
*/
|
3519
3519
|
DBSubnetGroup?: DBSubnetGroup;
|
3520
3520
|
/**
|
3521
|
-
*
|
3521
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
3522
3522
|
*/
|
3523
3523
|
PreferredMaintenanceWindow?: String;
|
3524
3524
|
/**
|
3525
|
-
*
|
3525
|
+
* Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
|
3526
3526
|
*/
|
3527
3527
|
PendingModifiedValues?: PendingModifiedValues;
|
3528
3528
|
/**
|
3529
|
-
*
|
3529
|
+
* The latest time to which a database in this DB instance can be restored with point-in-time restore.
|
3530
3530
|
*/
|
3531
3531
|
LatestRestorableTime?: TStamp;
|
3532
3532
|
/**
|
3533
|
-
*
|
3533
|
+
* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
|
3534
3534
|
*/
|
3535
3535
|
MultiAZ?: Boolean;
|
3536
3536
|
/**
|
3537
|
-
*
|
3537
|
+
* The version of the database engine.
|
3538
3538
|
*/
|
3539
3539
|
EngineVersion?: String;
|
3540
3540
|
/**
|
3541
|
-
*
|
3541
|
+
* Indicates whether minor version patches are applied automatically.
|
3542
3542
|
*/
|
3543
3543
|
AutoMinorVersionUpgrade?: Boolean;
|
3544
3544
|
/**
|
3545
|
-
*
|
3545
|
+
* The identifier of the source DB instance if this DB instance is a read replica.
|
3546
3546
|
*/
|
3547
3547
|
ReadReplicaSourceDBInstanceIdentifier?: String;
|
3548
3548
|
/**
|
3549
|
-
*
|
3549
|
+
* The identifiers of the read replicas associated with this DB instance.
|
3550
3550
|
*/
|
3551
3551
|
ReadReplicaDBInstanceIdentifiers?: ReadReplicaDBInstanceIdentifierList;
|
3552
3552
|
/**
|
3553
|
-
*
|
3553
|
+
* The 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 for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.
|
3554
3554
|
*/
|
3555
3555
|
ReadReplicaDBClusterIdentifiers?: ReadReplicaDBClusterIdentifierList;
|
3556
3556
|
/**
|
@@ -3558,15 +3558,15 @@ declare namespace RDS {
|
|
3558
3558
|
*/
|
3559
3559
|
ReplicaMode?: ReplicaMode;
|
3560
3560
|
/**
|
3561
|
-
*
|
3561
|
+
* The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
|
3562
3562
|
*/
|
3563
3563
|
LicenseModel?: String;
|
3564
3564
|
/**
|
3565
|
-
*
|
3565
|
+
* The Provisioned IOPS (I/O operations per second) value for the DB instance.
|
3566
3566
|
*/
|
3567
3567
|
Iops?: IntegerOptional;
|
3568
3568
|
/**
|
3569
|
-
*
|
3569
|
+
* The list of option group memberships for this DB instance.
|
3570
3570
|
*/
|
3571
3571
|
OptionGroupMemberships?: OptionGroupMembershipList;
|
3572
3572
|
/**
|
@@ -3582,15 +3582,15 @@ declare namespace RDS {
|
|
3582
3582
|
*/
|
3583
3583
|
SecondaryAvailabilityZone?: String;
|
3584
3584
|
/**
|
3585
|
-
*
|
3585
|
+
* Indicates whether the DB instance is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
|
3586
3586
|
*/
|
3587
3587
|
PubliclyAccessible?: Boolean;
|
3588
3588
|
/**
|
3589
|
-
* The status of a read replica. If the instance isn't a read replica,
|
3589
|
+
* The status of a read replica. If the DB instance isn't a read replica, the value is blank.
|
3590
3590
|
*/
|
3591
3591
|
StatusInfos?: DBInstanceStatusInfoList;
|
3592
3592
|
/**
|
3593
|
-
*
|
3593
|
+
* The storage type associated with the DB instance.
|
3594
3594
|
*/
|
3595
3595
|
StorageType?: String;
|
3596
3596
|
/**
|
@@ -3598,19 +3598,19 @@ declare namespace RDS {
|
|
3598
3598
|
*/
|
3599
3599
|
TdeCredentialArn?: String;
|
3600
3600
|
/**
|
3601
|
-
*
|
3601
|
+
* 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.
|
3602
3602
|
*/
|
3603
3603
|
DbInstancePort?: Integer;
|
3604
3604
|
/**
|
3605
|
-
* If the DB instance is a member of a DB cluster,
|
3605
|
+
* If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
|
3606
3606
|
*/
|
3607
3607
|
DBClusterIdentifier?: String;
|
3608
3608
|
/**
|
3609
|
-
*
|
3609
|
+
* Indicates whether the DB instance is encrypted.
|
3610
3610
|
*/
|
3611
3611
|
StorageEncrypted?: Boolean;
|
3612
3612
|
/**
|
3613
|
-
* If StorageEncrypted is
|
3613
|
+
* If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
3614
3614
|
*/
|
3615
3615
|
KmsKeyId?: String;
|
3616
3616
|
/**
|
@@ -3626,7 +3626,7 @@ declare namespace RDS {
|
|
3626
3626
|
*/
|
3627
3627
|
DomainMemberships?: DomainMembershipList;
|
3628
3628
|
/**
|
3629
|
-
*
|
3629
|
+
* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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.
|
3630
3630
|
*/
|
3631
3631
|
CopyTagsToSnapshot?: Boolean;
|
3632
3632
|
/**
|
@@ -3642,7 +3642,7 @@ declare namespace RDS {
|
|
3642
3642
|
*/
|
3643
3643
|
MonitoringRoleArn?: String;
|
3644
3644
|
/**
|
3645
|
-
*
|
3645
|
+
* The order of priority 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.
|
3646
3646
|
*/
|
3647
3647
|
PromotionTier?: IntegerOptional;
|
3648
3648
|
/**
|
@@ -3654,11 +3654,11 @@ declare namespace RDS {
|
|
3654
3654
|
*/
|
3655
3655
|
Timezone?: String;
|
3656
3656
|
/**
|
3657
|
-
*
|
3657
|
+
* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
|
3658
3658
|
*/
|
3659
3659
|
IAMDatabaseAuthenticationEnabled?: Boolean;
|
3660
3660
|
/**
|
3661
|
-
*
|
3661
|
+
* Indicates whether Performance Insights is enabled for the DB instance.
|
3662
3662
|
*/
|
3663
3663
|
PerformanceInsightsEnabled?: BooleanOptional;
|
3664
3664
|
/**
|
@@ -3666,11 +3666,11 @@ declare namespace RDS {
|
|
3666
3666
|
*/
|
3667
3667
|
PerformanceInsightsKMSKeyId?: String;
|
3668
3668
|
/**
|
3669
|
-
* The number of days to retain Performance Insights data.
|
3669
|
+
* The number of days to retain Performance Insights data. Valid Values: 7 month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) 731 Default: 7 days
|
3670
3670
|
*/
|
3671
3671
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
3672
3672
|
/**
|
3673
|
-
* 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
|
3673
|
+
* 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 Monitoring Amazon RDS log files in the Amazon RDS User Guide.
|
3674
3674
|
*/
|
3675
3675
|
EnabledCloudwatchLogsExports?: LogTypeList;
|
3676
3676
|
/**
|
@@ -3678,7 +3678,7 @@ declare namespace RDS {
|
|
3678
3678
|
*/
|
3679
3679
|
ProcessorFeatures?: ProcessorFeatureList;
|
3680
3680
|
/**
|
3681
|
-
* Indicates
|
3681
|
+
* Indicates whether 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.
|
3682
3682
|
*/
|
3683
3683
|
DeletionProtection?: Boolean;
|
3684
3684
|
/**
|
@@ -3686,7 +3686,7 @@ declare namespace RDS {
|
|
3686
3686
|
*/
|
3687
3687
|
AssociatedRoles?: DBInstanceRoles;
|
3688
3688
|
/**
|
3689
|
-
*
|
3689
|
+
* The listener connection endpoint for SQL Server Always On.
|
3690
3690
|
*/
|
3691
3691
|
ListenerEndpoint?: Endpoint;
|
3692
3692
|
/**
|
@@ -3699,7 +3699,7 @@ declare namespace RDS {
|
|
3699
3699
|
*/
|
3700
3700
|
DBInstanceAutomatedBackupsReplications?: DBInstanceAutomatedBackupsReplicationList;
|
3701
3701
|
/**
|
3702
|
-
*
|
3702
|
+
* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
3703
3703
|
*/
|
3704
3704
|
CustomerOwnedIpEnabled?: BooleanOptional;
|
3705
3705
|
/**
|
@@ -3739,11 +3739,11 @@ declare namespace RDS {
|
|
3739
3739
|
*/
|
3740
3740
|
CustomIamInstanceProfile?: String;
|
3741
3741
|
/**
|
3742
|
-
*
|
3742
|
+
* The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
|
3743
3743
|
*/
|
3744
3744
|
BackupTarget?: String;
|
3745
3745
|
/**
|
3746
|
-
* The network type of the DB instance.
|
3746
|
+
* The network type of the DB instance. The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide. Valid Values: IPV4 | DUAL
|
3747
3747
|
*/
|
3748
3748
|
NetworkType?: String;
|
3749
3749
|
/**
|
@@ -3751,15 +3751,15 @@ declare namespace RDS {
|
|
3751
3751
|
*/
|
3752
3752
|
ActivityStreamPolicyStatus?: ActivityStreamPolicyStatus;
|
3753
3753
|
/**
|
3754
|
-
*
|
3754
|
+
* The storage throughput for the DB instance. This setting applies only to the gp3 storage type.
|
3755
3755
|
*/
|
3756
3756
|
StorageThroughput?: IntegerOptional;
|
3757
3757
|
/**
|
3758
|
-
* The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is valid for RDS Custom
|
3758
|
+
* The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
|
3759
3759
|
*/
|
3760
3760
|
DBSystemId?: String;
|
3761
3761
|
/**
|
3762
|
-
*
|
3762
|
+
* The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
|
3763
3763
|
*/
|
3764
3764
|
MasterUserSecret?: MasterUserSecret;
|
3765
3765
|
/**
|
@@ -3767,7 +3767,7 @@ declare namespace RDS {
|
|
3767
3767
|
*/
|
3768
3768
|
CertificateDetails?: CertificateDetails;
|
3769
3769
|
/**
|
3770
|
-
*
|
3770
|
+
* The identifier of the source DB cluster if this DB instance is a read replica.
|
3771
3771
|
*/
|
3772
3772
|
ReadReplicaSourceDBClusterIdentifier?: String;
|
3773
3773
|
}
|
@@ -4812,11 +4812,11 @@ declare namespace RDS {
|
|
4812
4812
|
}
|
4813
4813
|
export interface DescribeDBClustersMessage {
|
4814
4814
|
/**
|
4815
|
-
* The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information
|
4815
|
+
* The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match an existing DB cluster identifier.
|
4816
4816
|
*/
|
4817
4817
|
DBClusterIdentifier?: String;
|
4818
4818
|
/**
|
4819
|
-
* A filter that specifies one or more DB clusters to describe. Supported
|
4819
|
+
* A filter that specifies one or more DB clusters to describe. Supported Filters: clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups. db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs. db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers. domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains. engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.
|
4820
4820
|
*/
|
4821
4821
|
Filters?: FilterList;
|
4822
4822
|
/**
|
@@ -4828,7 +4828,7 @@ declare namespace RDS {
|
|
4828
4828
|
*/
|
4829
4829
|
Marker?: String;
|
4830
4830
|
/**
|
4831
|
-
*
|
4831
|
+
* Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
|
4832
4832
|
*/
|
4833
4833
|
IncludeShared?: Boolean;
|
4834
4834
|
}
|
@@ -4902,11 +4902,11 @@ declare namespace RDS {
|
|
4902
4902
|
}
|
4903
4903
|
export interface DescribeDBInstancesMessage {
|
4904
4904
|
/**
|
4905
|
-
* The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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
|
4905
|
+
* The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.
|
4906
4906
|
*/
|
4907
4907
|
DBInstanceIdentifier?: String;
|
4908
4908
|
/**
|
4909
|
-
* A filter that specifies one or more DB instances to describe. Supported
|
4909
|
+
* 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 only includes 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 only includes information about the DB instances identified by these ARNs. dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers. domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains. engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
|
4910
4910
|
*/
|
4911
4911
|
Filters?: FilterList;
|
4912
4912
|
/**
|
@@ -6178,164 +6178,164 @@ declare namespace RDS {
|
|
6178
6178
|
}
|
6179
6179
|
export interface ModifyDBClusterMessage {
|
6180
6180
|
/**
|
6181
|
-
* The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
|
6181
|
+
* The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must match the identifier of an existing DB cluster.
|
6182
6182
|
*/
|
6183
6183
|
DBClusterIdentifier: String;
|
6184
6184
|
/**
|
6185
|
-
* 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
|
6185
|
+
* The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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
|
6186
6186
|
*/
|
6187
6187
|
NewDBClusterIdentifier?: String;
|
6188
6188
|
/**
|
6189
|
-
*
|
6189
|
+
* Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window. Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them. By default, this parameter is disabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
6190
6190
|
*/
|
6191
6191
|
ApplyImmediately?: Boolean;
|
6192
6192
|
/**
|
6193
|
-
* The number of days for which automated backups are retained. Specify a minimum value of 1. Default: 1
|
6193
|
+
* The number of days for which automated backups are retained. Specify a minimum value of 1. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Default: 1 Constraints: Must be a value from 1 to 35.
|
6194
6194
|
*/
|
6195
6195
|
BackupRetentionPeriod?: IntegerOptional;
|
6196
6196
|
/**
|
6197
|
-
* The name of the DB cluster parameter group to use for the DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
6197
|
+
* The name of the DB cluster parameter group to use for the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
6198
6198
|
*/
|
6199
6199
|
DBClusterParameterGroupName?: String;
|
6200
6200
|
/**
|
6201
|
-
* A list of VPC security groups
|
6201
|
+
* A list of EC2 VPC security groups to associate with this DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
6202
6202
|
*/
|
6203
6203
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
6204
6204
|
/**
|
6205
|
-
* The port number on which the DB cluster accepts connections.
|
6205
|
+
* The port number on which the DB cluster accepts connections. Valid for Cluster Type: Aurora DB clusters only Valid Values: 1150-65535 Default: The same port as the original DB cluster.
|
6206
6206
|
*/
|
6207
6207
|
Port?: IntegerOptional;
|
6208
6208
|
/**
|
6209
|
-
* The new password for the master database user.
|
6209
|
+
* The new password for the master database user. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: Must contain from 8 to 41 characters. Can contain any printable ASCII character except "/", """, or "@". Can't be specified if ManageMasterUserPassword is turned on.
|
6210
6210
|
*/
|
6211
6211
|
MasterUserPassword?: String;
|
6212
6212
|
/**
|
6213
|
-
*
|
6213
|
+
* The option group to associate the DB cluster with. DB clusters are associated with a default option group that can't be modified.
|
6214
6214
|
*/
|
6215
6215
|
OptionGroupName?: String;
|
6216
6216
|
/**
|
6217
|
-
* 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 Amazon Web Services Region. To view the time blocks available, see Backup 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.
|
6217
|
+
* 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 Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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.
|
6218
6218
|
*/
|
6219
6219
|
PreferredBackupWindow?: String;
|
6220
6220
|
/**
|
6221
|
-
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
6221
|
+
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services 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. Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun. Must be in Universal Coordinated Time (UTC). Must be at least 30 minutes.
|
6222
6222
|
*/
|
6223
6223
|
PreferredMaintenanceWindow?: String;
|
6224
6224
|
/**
|
6225
|
-
*
|
6225
|
+
* Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
|
6226
6226
|
*/
|
6227
6227
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
6228
6228
|
/**
|
6229
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0
|
6229
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Valid for Cluster Type: Aurora MySQL DB clusters only Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
6230
6230
|
*/
|
6231
6231
|
BacktrackWindow?: LongOptional;
|
6232
6232
|
/**
|
6233
|
-
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
|
6233
|
+
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The following values are valid for each DB engine: Aurora MySQL - audit | error | general | slowquery Aurora PostgreSQL - postgresql RDS for MySQL - error | general | slowquery RDS for PostgreSQL - postgresql | upgrade For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
|
6234
6234
|
*/
|
6235
6235
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
6236
6236
|
/**
|
6237
|
-
* 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. If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify. To list all of the available engine versions for Aurora MySQL, 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" To list all of the available engine versions for RDS for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
6237
|
+
* 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. If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify. To list all of the available engine versions for Aurora MySQL, 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" To list all of the available engine versions for RDS for MySQL, use the following command: aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for RDS for PostgreSQL, use the following command: aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
6238
6238
|
*/
|
6239
6239
|
EngineVersion?: String;
|
6240
6240
|
/**
|
6241
|
-
*
|
6241
|
+
* Specifies whether major version upgrades are allowed. Valid for Cluster Type: Aurora DB clusters only 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.
|
6242
6242
|
*/
|
6243
6243
|
AllowMajorVersionUpgrade?: Boolean;
|
6244
6244
|
/**
|
6245
|
-
* 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 are applied immediately rather than during the next maintenance window. 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 valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
|
6245
|
+
* 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 are applied immediately rather than during the next maintenance window. Valid for Cluster Type: Aurora DB clusters only 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 valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
|
6246
6246
|
*/
|
6247
6247
|
DBInstanceParameterGroupName?: String;
|
6248
6248
|
/**
|
6249
|
-
* 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. For more information, see Kerberos Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
6249
|
+
* 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. For more information, see Kerberos Authentication in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
|
6250
6250
|
*/
|
6251
6251
|
Domain?: String;
|
6252
6252
|
/**
|
6253
|
-
*
|
6253
|
+
* The name of the IAM role to use when making API calls to the Directory Service. Valid for Cluster Type: Aurora DB clusters only
|
6254
6254
|
*/
|
6255
6255
|
DomainIAMRoleName?: String;
|
6256
6256
|
/**
|
6257
|
-
* The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode. Valid for: Aurora DB clusters only
|
6257
|
+
* The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode. Valid for Cluster Type: Aurora DB clusters only
|
6258
6258
|
*/
|
6259
6259
|
ScalingConfiguration?: ScalingConfiguration;
|
6260
6260
|
/**
|
6261
|
-
*
|
6261
|
+
* Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
6262
6262
|
*/
|
6263
6263
|
DeletionProtection?: BooleanOptional;
|
6264
6264
|
/**
|
6265
|
-
*
|
6265
|
+
* Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only
|
6266
6266
|
*/
|
6267
6267
|
EnableHttpEndpoint?: BooleanOptional;
|
6268
6268
|
/**
|
6269
|
-
*
|
6269
|
+
* Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
6270
6270
|
*/
|
6271
6271
|
CopyTagsToSnapshot?: BooleanOptional;
|
6272
6272
|
/**
|
6273
|
-
*
|
6273
|
+
* Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. Valid for Cluster Type: Aurora DB clusters only
|
6274
6274
|
*/
|
6275
6275
|
EnableGlobalWriteForwarding?: BooleanOptional;
|
6276
6276
|
/**
|
6277
|
-
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services 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. Valid for: Multi-AZ DB clusters only
|
6277
|
+
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services 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. Valid for Cluster Type: Multi-AZ DB clusters only
|
6278
6278
|
*/
|
6279
6279
|
DBClusterInstanceClass?: String;
|
6280
6280
|
/**
|
6281
|
-
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Valid for: Multi-AZ DB clusters only
|
6281
|
+
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only
|
6282
6282
|
*/
|
6283
6283
|
AllocatedStorage?: IntegerOptional;
|
6284
6284
|
/**
|
6285
|
-
*
|
6285
|
+
* The storage type to associate with the DB cluster. For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters. When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: Aurora DB clusters - aurora | aurora-iopt1 Multi-AZ DB clusters - io1 Default: Aurora DB clusters - aurora Multi-AZ DB clusters - io1
|
6286
6286
|
*/
|
6287
6287
|
StorageType?: String;
|
6288
6288
|
/**
|
6289
|
-
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide. Constraints:
|
6289
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
|
6290
6290
|
*/
|
6291
6291
|
Iops?: IntegerOptional;
|
6292
6292
|
/**
|
6293
|
-
*
|
6293
|
+
* Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only
|
6294
6294
|
*/
|
6295
6295
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
6296
6296
|
/**
|
6297
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.
|
6297
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
|
6298
6298
|
*/
|
6299
6299
|
MonitoringInterval?: IntegerOptional;
|
6300
6300
|
/**
|
6301
|
-
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see 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, supply a MonitoringRoleArn value. Valid for: Multi-AZ DB clusters only
|
6301
|
+
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see 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, supply a MonitoringRoleArn value. Valid for Cluster Type: Multi-AZ DB clusters only
|
6302
6302
|
*/
|
6303
6303
|
MonitoringRoleArn?: String;
|
6304
6304
|
/**
|
6305
|
-
*
|
6305
|
+
* Specifies whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only
|
6306
6306
|
*/
|
6307
6307
|
EnablePerformanceInsights?: BooleanOptional;
|
6308
6308
|
/**
|
6309
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for: Multi-AZ DB clusters only
|
6309
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for Cluster Type: Multi-AZ DB clusters only
|
6310
6310
|
*/
|
6311
6311
|
PerformanceInsightsKMSKeyId?: String;
|
6312
6312
|
/**
|
6313
|
-
* The number of days to retain Performance Insights data.
|
6313
|
+
* The number of days to retain Performance Insights data. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: 7 month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.
|
6314
6314
|
*/
|
6315
6315
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
6316
6316
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
6317
6317
|
/**
|
6318
|
-
* The network type of the DB cluster.
|
6318
|
+
* The network type of the DB cluster. The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only Valid Values: IPV4 | DUAL
|
6319
6319
|
*/
|
6320
6320
|
NetworkType?: String;
|
6321
6321
|
/**
|
6322
|
-
*
|
6322
|
+
* Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword. If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
6323
6323
|
*/
|
6324
6324
|
ManageMasterUserPassword?: BooleanOptional;
|
6325
6325
|
/**
|
6326
|
-
*
|
6326
|
+
* Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints: You must apply the change immediately when rotating the master user password.
|
6327
6327
|
*/
|
6328
6328
|
RotateMasterUserPassword?: BooleanOptional;
|
6329
6329
|
/**
|
6330
|
-
* The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if both of the following conditions are met: The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret. You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
6330
|
+
* The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if both of the following conditions are met: The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret. You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
6331
6331
|
*/
|
6332
6332
|
MasterUserSecretKmsKeyId?: String;
|
6333
6333
|
/**
|
6334
|
-
* The DB engine mode of the DB cluster, either provisioned or serverless. The DB engine mode can be modified only from serverless to provisioned. For more information, see CreateDBCluster. Valid for: Aurora DB clusters only
|
6334
|
+
* The DB engine mode of the DB cluster, either provisioned or serverless. The DB engine mode can be modified only from serverless to provisioned. For more information, see CreateDBCluster. Valid for Cluster Type: Aurora DB clusters only
|
6335
6335
|
*/
|
6336
6336
|
EngineMode?: String;
|
6337
6337
|
/**
|
6338
|
-
*
|
6338
|
+
* Specifies whether engine mode changes from serverless to provisioned are allowed. Valid for Cluster Type: Aurora Serverless v1 DB clusters only Constraints: You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.
|
6339
6339
|
*/
|
6340
6340
|
AllowEngineModeChange?: Boolean;
|
6341
6341
|
}
|
@@ -6375,11 +6375,11 @@ declare namespace RDS {
|
|
6375
6375
|
}
|
6376
6376
|
export interface ModifyDBInstanceMessage {
|
6377
6377
|
/**
|
6378
|
-
* The DB instance
|
6378
|
+
* The identifier of DB instance to modify. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DB instance.
|
6379
6379
|
*/
|
6380
6380
|
DBInstanceIdentifier: String;
|
6381
6381
|
/**
|
6382
|
-
* The new amount of storage in gibibytes (GiB) 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.
|
6382
|
+
* The new amount of storage in gibibytes (GiB) to allocate for the DB instance. For RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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.
|
6383
6383
|
*/
|
6384
6384
|
AllocatedStorage?: IntegerOptional;
|
6385
6385
|
/**
|
@@ -6387,195 +6387,195 @@ declare namespace RDS {
|
|
6387
6387
|
*/
|
6388
6388
|
DBInstanceClass?: String;
|
6389
6389
|
/**
|
6390
|
-
* 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 Working with a DB instance in a VPC 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. This parameter doesn't apply to RDS Custom. Constraints:
|
6390
|
+
* 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 Working with a DB instance in a VPC 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. This parameter doesn't apply to RDS Custom DB instances. Constraints: If supplied, must match existing DB subnet group. Example: mydbsubnetgroup
|
6391
6391
|
*/
|
6392
6392
|
DBSubnetGroupName?: String;
|
6393
6393
|
/**
|
6394
|
-
* 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. This setting doesn't apply to RDS Custom. Constraints: If supplied, must match existing
|
6394
|
+
* 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. This setting doesn't apply to RDS Custom DB instances. Constraints: If supplied, must match existing DB security groups.
|
6395
6395
|
*/
|
6396
6396
|
DBSecurityGroups?: DBSecurityGroupNameList;
|
6397
6397
|
/**
|
6398
|
-
* A list of Amazon EC2 VPC security groups to
|
6398
|
+
* A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible. This setting doesn't apply to the following DB instances: Amazon Aurora (The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.) RDS Custom Constraints: If supplied, must match existing VPC security group IDs.
|
6399
6399
|
*/
|
6400
6400
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
6401
6401
|
/**
|
6402
|
-
*
|
6402
|
+
* Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. 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.
|
6403
6403
|
*/
|
6404
6404
|
ApplyImmediately?: Boolean;
|
6405
6405
|
/**
|
6406
|
-
* The new password for the master user.
|
6406
|
+
* The new password for the master user. 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 RDS API operations 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. This setting doesn't apply to the following DB instances: Amazon Aurora (The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.) RDS Custom Default: Uses existing setting Constraints: Can't be specified if ManageMasterUserPassword is turned on. Can include any printable ASCII character except "/", """, or "@". Length Constraints: RDS for MariaDB - Must contain from 8 to 41 characters. RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. RDS for MySQL - Must contain from 8 to 41 characters. RDS for Oracle - Must contain from 8 to 30 characters. RDS for PostgreSQL - Must contain from 8 to 128 characters.
|
6407
6407
|
*/
|
6408
6408
|
MasterUserPassword?: String;
|
6409
6409
|
/**
|
6410
|
-
* 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 aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot. This setting doesn't apply to RDS Custom. Default: Uses existing setting Constraints:
|
6410
|
+
* 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 aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot. This setting doesn't apply to RDS Custom DB instances. Default: Uses existing setting Constraints: Must be in the same DB parameter group family as the DB instance.
|
6411
6411
|
*/
|
6412
6412
|
DBParameterGroupName?: String;
|
6413
6413
|
/**
|
6414
|
-
* 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. Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance. 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.
|
6414
|
+
* 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. Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance. 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. This setting doesn't apply to Amazon Aurora DB instances. 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't be set to 0 if the DB instance is a source to read replicas. Can't be set to 0 for an RDS Custom for Oracle DB instance.
|
6415
6415
|
*/
|
6416
6416
|
BackupRetentionPeriod?: IntegerOptional;
|
6417
6417
|
/**
|
6418
|
-
* 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. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
|
6418
|
+
* 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. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora DB instances. 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 Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
|
6419
6419
|
*/
|
6420
6420
|
PreferredBackupWindow?: String;
|
6421
6421
|
/**
|
6422
|
-
* The weekly time range
|
6422
|
+
* The weekly time range 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 causes a reboot of the DB instance. If you change 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. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. Default: Uses existing setting Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. The day values must be 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.
|
6423
6423
|
*/
|
6424
6424
|
PreferredMaintenanceWindow?: String;
|
6425
6425
|
/**
|
6426
|
-
*
|
6426
|
+
* Specifies whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. This setting doesn't apply to RDS Custom DB instances.
|
6427
6427
|
*/
|
6428
6428
|
MultiAZ?: BooleanOptional;
|
6429
6429
|
/**
|
6430
|
-
* 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 enabled 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. If you specify only a major version, Amazon RDS
|
6430
|
+
* 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 enabled 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. If you specify only a major version, Amazon RDS updates the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. If the instance that you're modifying is acting as a read replica, the engine version that you specify must be the same or higher than the version that the source DB instance or cluster is running. In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
|
6431
6431
|
*/
|
6432
6432
|
EngineVersion?: String;
|
6433
6433
|
/**
|
6434
|
-
*
|
6434
|
+
* Specifies 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. This setting doesn't apply to RDS Custom DB instances. Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that's a different major version than the DB instance's current version.
|
6435
6435
|
*/
|
6436
6436
|
AllowMajorVersionUpgrade?: Boolean;
|
6437
6437
|
/**
|
6438
|
-
*
|
6438
|
+
* Specifies whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met: The automatic upgrade is enabled for the maintenance window. A newer minor version is available. RDS has enabled automatic patching for the engine version. If any of the preceding conditions isn't met, Amazon RDS applies the change as soon as possible and doesn't cause an outage. For an RDS Custom DB instance, don't enable this setting. Otherwise, the operation returns an error.
|
6439
6439
|
*/
|
6440
6440
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
6441
6441
|
/**
|
6442
|
-
* The license model for the DB instance. This setting doesn't apply to RDS Custom. Valid
|
6442
|
+
* The license model for the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values: RDS for MariaDB - general-public-license RDS for Microsoft SQL Server - license-included RDS for MySQL - general-public-license RDS for Oracle - bring-your-own-license | license-included RDS for PostgreSQL - postgresql-license
|
6443
6443
|
*/
|
6444
6444
|
LicenseModel?: String;
|
6445
6445
|
/**
|
6446
|
-
* 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:
|
6446
|
+
* 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 RDS for MariaDB, RDS for MySQL, RDS for Oracle, and RDS for 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
|
6447
6447
|
*/
|
6448
6448
|
Iops?: IntegerOptional;
|
6449
6449
|
/**
|
6450
|
-
*
|
6450
|
+
* The option group to associate the DB instance with. Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. 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 after it is associated with a DB instance. This setting doesn't apply to RDS Custom DB instances.
|
6451
6451
|
*/
|
6452
6452
|
OptionGroupName?: String;
|
6453
6453
|
/**
|
6454
|
-
* The new
|
6454
|
+
* The new 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 ApplyImmediately. This value is stored as a lowercase string. This setting doesn't apply to RDS Custom DB instances. 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
|
6455
6455
|
*/
|
6456
6456
|
NewDBInstanceIdentifier?: String;
|
6457
6457
|
/**
|
6458
|
-
*
|
6458
|
+
* The storage type to associate 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: gp2 | gp3 | io1 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp2.
|
6459
6459
|
*/
|
6460
6460
|
StorageType?: String;
|
6461
6461
|
/**
|
6462
|
-
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
6462
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom DB instances.
|
6463
6463
|
*/
|
6464
6464
|
TdeCredentialArn?: String;
|
6465
6465
|
/**
|
6466
|
-
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
6466
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom DB instances.
|
6467
6467
|
*/
|
6468
6468
|
TdeCredentialPassword?: String;
|
6469
6469
|
/**
|
6470
|
-
*
|
6470
|
+
* The CA certificate identifier to use for the DB instance6's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
|
6471
6471
|
*/
|
6472
6472
|
CACertificateIdentifier?: String;
|
6473
6473
|
/**
|
6474
|
-
* The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
6474
|
+
* The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
|
6475
6475
|
*/
|
6476
6476
|
Domain?: String;
|
6477
6477
|
/**
|
6478
|
-
*
|
6478
|
+
* Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags aren't copied. This setting doesn't apply to Amazon Aurora DB instances. 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.
|
6479
6479
|
*/
|
6480
6480
|
CopyTagsToSnapshot?: BooleanOptional;
|
6481
6481
|
/**
|
6482
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable
|
6482
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
|
6483
6483
|
*/
|
6484
6484
|
MonitoringInterval?: IntegerOptional;
|
6485
6485
|
/**
|
6486
|
-
* 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. If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter. This setting doesn't apply to RDS Custom.
|
6486
|
+
* 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. If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter. This setting doesn't apply to RDS Custom DB instances. Valid Values: 1150-65535 Default: Amazon Aurora - 3306 RDS for MariaDB - 3306 RDS for Microsoft SQL Server - 1433 RDS for MySQL - 3306 RDS for Oracle - 1521 RDS for PostgreSQL - 5432 Constraints: For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
|
6487
6487
|
*/
|
6488
6488
|
DBPortNumber?: IntegerOptional;
|
6489
6489
|
/**
|
6490
|
-
*
|
6490
|
+
* Specifies whether the DB instance is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB 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.
|
6491
6491
|
*/
|
6492
6492
|
PubliclyAccessible?: BooleanOptional;
|
6493
6493
|
/**
|
6494
|
-
* 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 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, supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom.
|
6494
|
+
* 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 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, supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom DB instances.
|
6495
6495
|
*/
|
6496
6496
|
MonitoringRoleArn?: String;
|
6497
6497
|
/**
|
6498
|
-
* The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
6498
|
+
* The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to RDS Custom DB instances.
|
6499
6499
|
*/
|
6500
6500
|
DomainIAMRoleName?: String;
|
6501
6501
|
/**
|
6502
|
-
*
|
6502
|
+
* The order of priority 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. This setting doesn't apply to RDS Custom DB instances. Default: 1 Valid Values: 0 - 15
|
6503
6503
|
*/
|
6504
6504
|
PromotionTier?: IntegerOptional;
|
6505
6505
|
/**
|
6506
|
-
*
|
6506
|
+
* Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
|
6507
6507
|
*/
|
6508
6508
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
6509
6509
|
/**
|
6510
|
-
*
|
6510
|
+
* Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
|
6511
6511
|
*/
|
6512
6512
|
EnablePerformanceInsights?: BooleanOptional;
|
6513
6513
|
/**
|
6514
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you
|
6514
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom DB instances.
|
6515
6515
|
*/
|
6516
6516
|
PerformanceInsightsKMSKeyId?: String;
|
6517
6517
|
/**
|
6518
|
-
* The number of days to retain Performance Insights data.
|
6518
|
+
* The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: 7 month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) 731 Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.
|
6519
6519
|
*/
|
6520
6520
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
6521
6521
|
/**
|
6522
|
-
* The
|
6522
|
+
* 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. This setting doesn't apply to RDS Custom DB instances.
|
6523
6523
|
*/
|
6524
6524
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
6525
6525
|
/**
|
6526
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
6526
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom DB instances.
|
6527
6527
|
*/
|
6528
6528
|
ProcessorFeatures?: ProcessorFeatureList;
|
6529
6529
|
/**
|
6530
|
-
*
|
6530
|
+
* Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
|
6531
6531
|
*/
|
6532
6532
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
6533
6533
|
/**
|
6534
|
-
*
|
6534
|
+
* Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
|
6535
6535
|
*/
|
6536
6536
|
DeletionProtection?: BooleanOptional;
|
6537
6537
|
/**
|
6538
|
-
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
6538
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
|
6539
6539
|
*/
|
6540
6540
|
MaxAllocatedStorage?: IntegerOptional;
|
6541
6541
|
/**
|
6542
|
-
*
|
6542
|
+
* Specifies 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. This setting doesn't apply to RDS Custom DB instances.
|
6543
6543
|
*/
|
6544
6544
|
CertificateRotationRestart?: BooleanOptional;
|
6545
6545
|
/**
|
6546
|
-
* A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
6546
|
+
* A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
|
6547
6547
|
*/
|
6548
6548
|
ReplicaMode?: ReplicaMode;
|
6549
6549
|
/**
|
6550
|
-
*
|
6550
|
+
* Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
6551
6551
|
*/
|
6552
6552
|
EnableCustomerOwnedIp?: BooleanOptional;
|
6553
6553
|
/**
|
6554
|
-
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. This setting doesn't apply to RDS Custom.
|
6554
|
+
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. This setting doesn't apply to RDS Custom DB instances.
|
6555
6555
|
*/
|
6556
6556
|
AwsBackupRecoveryPointArn?: AwsBackupRecoveryPointArn;
|
6557
6557
|
/**
|
6558
|
-
* The automation mode of the RDS Custom DB instance
|
6558
|
+
* The automation mode of the RDS Custom DB instance. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.
|
6559
6559
|
*/
|
6560
6560
|
AutomationMode?: AutomationMode;
|
6561
6561
|
/**
|
6562
|
-
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.
|
6562
|
+
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. Default: 60 Constraints: Must be at least 60. Must be no more than 1,440.
|
6563
6563
|
*/
|
6564
6564
|
ResumeFullAutomationModeMinutes?: IntegerOptional;
|
6565
6565
|
/**
|
6566
|
-
* The network type of the DB instance.
|
6566
|
+
* The network type of the DB instance. The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. Valid Values: IPV4 | DUAL
|
6567
6567
|
*/
|
6568
6568
|
NetworkType?: String;
|
6569
6569
|
/**
|
6570
|
-
*
|
6570
|
+
* The storage throughput value for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
|
6571
6571
|
*/
|
6572
6572
|
StorageThroughput?: IntegerOptional;
|
6573
6573
|
/**
|
6574
|
-
*
|
6574
|
+
* Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the DB instance doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword. If the DB instance already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
|
6575
6575
|
*/
|
6576
6576
|
ManageMasterUserPassword?: BooleanOptional;
|
6577
6577
|
/**
|
6578
|
-
*
|
6578
|
+
* Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints: You must apply the change immediately when rotating the master user password.
|
6579
6579
|
*/
|
6580
6580
|
RotateMasterUserPassword?: BooleanOptional;
|
6581
6581
|
/**
|
@@ -6711,7 +6711,7 @@ declare namespace RDS {
|
|
6711
6711
|
*/
|
6712
6712
|
DBSnapshotIdentifier: String;
|
6713
6713
|
/**
|
6714
|
-
* 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.
|
6714
|
+
* 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 19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots) 19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots) 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.
|
6715
6715
|
*/
|
6716
6716
|
EngineVersion?: String;
|
6717
6717
|
/**
|