Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the Amazon Web Services resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an insight that includes recommendations, related events, and related metrics that can help you improve your operational applications. For more information, see What is Amazon DevOps Guru.
You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each insight to help you manage and track your work addressing insights.
To learn about the DevOps Guru workflow, see How DevOps Guru works. To learn about DevOps Guru concepts, see Concepts in DevOps Guru.
", "operations": { - "AddNotificationChannel": "Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
", + "AddNotificationChannel": "Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
", "DeleteInsight": "Deletes the insight along with the associated anomalies, events and recommendations.
", "DescribeAccountHealth": "Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account.
", "DescribeAccountOverview": "For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.
", @@ -833,6 +833,25 @@ "refs": { } }, + "KMSKeyId": { + "base": null, + "refs": { + "KMSServerSideEncryptionIntegration$KMSKeyId": "Describes the specified KMS key.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), Amazon Web Services KMS associates the alias with an Amazon Web Services managed key and returns its KeyId and Arn in the response. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
", + "KMSServerSideEncryptionIntegrationConfig$KMSKeyId": "Describes the specified KMS key.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), Amazon Web Services KMS associates the alias with an Amazon Web Services managed key and returns its KeyId and Arn in the response. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
" + } + }, + "KMSServerSideEncryptionIntegration": { + "base": "Information about the KMS encryption used with DevOps Guru.
", + "refs": { + "ServiceIntegrationConfig$KMSServerSideEncryption": "Information about whether DevOps Guru is configured to encrypt server-side data using KMS.
" + } + }, + "KMSServerSideEncryptionIntegrationConfig": { + "base": "Information about whether DevOps Guru is configured to encrypt server-side data using KMS.
", + "refs": { + "UpdateServiceIntegrationConfig$KMSServerSideEncryption": "Information about whether DevOps Guru is configured to encrypt server-side data using KMS.
" + } + }, "ListAnomaliesForInsightFilters": { "base": "Specifies one or more service names that are used to list anomalies.
", "refs": { @@ -1103,7 +1122,7 @@ } }, "NotificationChannel": { - "base": "Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
", + "base": "Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
", "refs": { "Channels$member": null } @@ -1209,6 +1228,8 @@ "OptInStatus": { "base": "Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created insight.
", "refs": { + "KMSServerSideEncryptionIntegration$OptInStatus": "Specifies if DevOps Guru is enabled for customer managed keys.
", + "KMSServerSideEncryptionIntegrationConfig$OptInStatus": "Specifies if DevOps Guru is enabled for KMS integration.
", "LogsAnomalyDetectionIntegration$OptInStatus": "Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups.
", "LogsAnomalyDetectionIntegrationConfig$OptInStatus": "Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups.
", "OpsCenterIntegration$OptInStatus": "Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created insight.
", @@ -1834,6 +1855,13 @@ "refs": { } }, + "ServerSideEncryptionType": { + "base": null, + "refs": { + "KMSServerSideEncryptionIntegration$Type": "The type of KMS key used. Customer managed keys are the KMS keys that you create. Amazon Web Services owned keys are keys that are owned and managed by DevOps Guru.
", + "KMSServerSideEncryptionIntegrationConfig$Type": "The type of KMS key used. Customer managed keys are the KMS keys that you create. Amazon Web Services owned keys are keys that are owned and managed by DevOps Guru.
" + } + }, "ServiceCollection": { "base": "A collection of the names of Amazon Web Services services.
", "refs": { @@ -1902,9 +1930,9 @@ } }, "SnsChannelConfig": { - "base": "Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
", + "base": "Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
", "refs": { - "NotificationChannelConfig$Sns": "Information about a notification channel configured in DevOps Guru to send notifications when insights are created.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
" + "NotificationChannelConfig$Sns": "Information about a notification channel configured in DevOps Guru to send notifications when insights are created.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics.
" } }, "SsmOpsItemId": { diff --git a/models/apis/devops-guru/2020-12-01/endpoint-tests-1.json b/models/apis/devops-guru/2020-12-01/endpoint-tests-1.json index c03e296a37e..22829574c14 100644 --- a/models/apis/devops-guru/2020-12-01/endpoint-tests-1.json +++ b/models/apis/devops-guru/2020-12-01/endpoint-tests-1.json @@ -9,8 +9,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -22,8 +22,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -35,8 +35,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -48,8 +48,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -61,8 +61,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -74,8 +74,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -87,8 +87,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -100,8 +100,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -113,8 +113,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -126,8 +126,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -139,8 +139,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -152,8 +152,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -165,8 +165,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -178,8 +178,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -191,8 +191,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -204,8 +204,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -217,8 +217,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -230,8 +230,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -243,8 +243,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -256,8 +256,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -269,8 +269,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -282,8 +282,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -295,8 +306,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -308,8 +330,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -321,8 +354,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -334,8 +378,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -347,8 +391,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -360,8 +404,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -372,8 +416,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -384,10 +428,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" diff --git a/models/apis/fsx/2018-03-01/docs-2.json b/models/apis/fsx/2018-03-01/docs-2.json index 98cb572b22f..a34c85f6db3 100644 --- a/models/apis/fsx/2018-03-01/docs-2.json +++ b/models/apis/fsx/2018-03-01/docs-2.json @@ -198,19 +198,19 @@ } }, "AutomaticBackupRetentionDays": { - "base": "The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.
The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.
", + "CreateFileSystemWindowsConfiguration$AutomaticBackupRetentionDays": "The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.
The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups.
", + "UpdateFileSystemWindowsConfiguration$AutomaticBackupRetentionDays": "The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30. For more information, see Working with Automatic Daily Backups.
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
" } }, @@ -1867,7 +1867,7 @@ "OpenZFSDeploymentType": { "base": null, "refs": { - "CreateFileSystemOpenZFSConfiguration$DeploymentType": "Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:
SINGLE_AZ_1- (Default) Creates file systems with throughput capacities of 64 - 4,096 MBps. Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available, except US West (Oregon).
SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MBps using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.
", + "CreateFileSystemOpenZFSConfiguration$DeploymentType": "Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:
SINGLE_AZ_1- (Default) Creates file systems with throughput capacities of 64 - 4,096 MBps. Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available.
SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.
", "OpenZFSFileSystemConfiguration$DeploymentType": "Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
SINGLE_AZ_1 and SINGLE_AZ_2.
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
", "DescribeDBClusterSnapshotAttributes": "Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
Returns information about DB cluster snapshots. This API action 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.
", - "DescribeDBClusters": "Returns information about 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.
", + "DescribeDBClusters": "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.
", "DescribeDBEngineVersions": "Returns a list of the available DB engines.
", "DescribeDBInstanceAutomatedBackups": "Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.
All parameters are optional.
", - "DescribeDBInstances": "Returns information about provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
", "DescribeDBParameterGroups": "Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Returns the detailed parameter list for a particular DB parameter group.
", @@ -97,7 +97,7 @@ "ModifyCertificates": "Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified Amazon Web Services Region.
RDS has already moved to a new default CA certificate for the specified Amazon Web Services Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
", "ModifyCurrentDBClusterCapacity": "Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
This action only applies to Aurora Serverless v1 DB clusters.
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
", - "ModifyDBCluster": "Modify the settings for 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.
", + "ModifyDBCluster": "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.
", "ModifyDBClusterEndpoint": "Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
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.
", "ModifyDBClusterSnapshotAttribute": "Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.
Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.
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.
The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
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
", - "DBCluster$AvailabilityZones": "Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
", + "CreateDBClusterMessage$AvailabilityZones": "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
", + "DBCluster$AvailabilityZones": "The list of Availability Zones (AZs) where instances in the DB cluster can be created.
", "DBClusterSnapshot$AvailabilityZones": "Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
", "RestoreDBClusterFromS3Message$AvailabilityZones": "A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
", "RestoreDBClusterFromSnapshotMessage$AvailabilityZones": "Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
" @@ -332,7 +332,7 @@ "AwsBackupRecoveryPointArn": { "base": null, "refs": { - "ModifyDBInstanceMessage$AwsBackupRecoveryPointArn": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
" + "ModifyDBInstanceMessage$AwsBackupRecoveryPointArn": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom DB instances.
" } }, "BacktrackDBClusterMessage": { @@ -427,8 +427,8 @@ "refs": { "CreateDBProxyRequest$RequireTLS": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
", "CreateDBProxyRequest$DebugLogging": "Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
", - "DBCluster$StorageEncrypted": "Specifies whether the DB cluster is encrypted.
", - "DBCluster$AutoMinorVersionUpgrade": "A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
", + "DBCluster$StorageEncrypted": "Indicates whether the DB cluster is encrypted.
", + "DBCluster$AutoMinorVersionUpgrade": "Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
", "DBClusterMember$IsClusterWriter": "Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies whether the DB cluster snapshot is encrypted.
", "DBClusterSnapshot$IAMDatabaseAuthenticationEnabled": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
", @@ -437,13 +437,13 @@ "DBEngineVersion$SupportsParallelQuery": "A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
", "DBEngineVersion$SupportsGlobalDatabases": "A value that indicates whether you can use Aurora global databases with a specific DB engine version.
", "DBEngineVersion$SupportsBabelfish": "A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
", - "DBInstance$MultiAZ": "Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
", - "DBInstance$AutoMinorVersionUpgrade": "A value that indicates that minor version patches are applied automatically.
", - "DBInstance$PubliclyAccessible": "Specifies the accessibility options for the DB instance.
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.
", - "DBInstance$StorageEncrypted": "Specifies whether the DB instance is encrypted.
", - "DBInstance$CopyTagsToSnapshot": "Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
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.
", - "DBInstance$DeletionProtection": "Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
", + "DBInstance$MultiAZ": "Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
", + "DBInstance$AutoMinorVersionUpgrade": "Indicates whether minor version patches are applied automatically.
", + "DBInstance$PubliclyAccessible": "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.
", + "DBInstance$StorageEncrypted": "Indicates whether the DB instance is encrypted.
", + "DBInstance$CopyTagsToSnapshot": "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.
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.
", + "DBInstance$DeletionProtection": "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.
", "DBInstanceAutomatedBackup$Encrypted": "Specifies whether the automated backup is encrypted.
", "DBInstanceAutomatedBackup$IAMDatabaseAuthenticationEnabled": "True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
", "DBInstanceStatusInfo$Normal": "Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
", @@ -457,18 +457,18 @@ "DeleteDBInstanceMessage$SkipFinalSnapshot": "A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.
If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
", "DescribeDBClusterSnapshotsMessage$IncludeShared": "A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
", - "DescribeDBClustersMessage$IncludeShared": "Optional Boolean parameter that specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
", + "DescribeDBClustersMessage$IncludeShared": "Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
", "DescribeDBEngineVersionsMessage$DefaultOnly": "A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
", "DescribeDBSnapshotsMessage$IncludeShared": "A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
", "DescribeDBSnapshotsMessage$IncludePublic": "A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
", "DownloadDBLogFilePortionDetails$AdditionalDataPending": "Boolean value that if true, indicates there is more data to be downloaded.
", "EventSubscription$Enabled": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
", "GlobalClusterMember$IsWriter": "Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
", - "ModifyDBClusterMessage$ApplyImmediately": "A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
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: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$AllowMajorVersionUpgrade": "A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
Valid for: Aurora DB clusters only
", - "ModifyDBClusterMessage$AllowEngineModeChange": "A value that indicates whether engine mode changes from serverless to provisioned are allowed.
Constraints: You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.
Valid for: Aurora Serverless v1 DB clusters only
", - "ModifyDBInstanceMessage$ApplyImmediately": "A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
", + "ModifyDBClusterMessage$ApplyImmediately": "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
", + "ModifyDBClusterMessage$AllowMajorVersionUpgrade": "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.
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.
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.
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.
A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
", "Option$Persistent": "Indicate if this option is persistent.
", "Option$Permanent": "Indicate if this option is permanent.
", @@ -519,26 +519,26 @@ "CopyDBClusterSnapshotMessage$CopyTags": "A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
", "CopyDBSnapshotMessage$CopyTags": "A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied.
", "CopyDBSnapshotMessage$CopyOptionGroup": "A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
", - "CreateDBClusterMessage$StorageEncrypted": "A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$EnableIAMDatabaseAuthentication": "A value that indicates 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: Aurora DB clusters only
", - "CreateDBClusterMessage$DeletionProtection": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$EnableHttpEndpoint": "A value that indicates 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: Aurora DB clusters only
", - "CreateDBClusterMessage$CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$EnableGlobalWriteForwarding": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
", - "CreateDBClusterMessage$PubliclyAccessible": "A value that 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.
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.
Valid for: Multi-AZ DB clusters only
", - "CreateDBClusterMessage$AutoMinorVersionUpgrade": "A value that indicates 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: Multi-AZ DB clusters only
", - "CreateDBClusterMessage$EnablePerformanceInsights": "A value that indicates 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: Multi-AZ DB clusters only
", - "CreateDBClusterMessage$ManageMasterUserPassword": "A value that indicates 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.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBInstanceMessage$MultiAZ": "A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
", - "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
A value that indicates 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.
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
For RDS Custom instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
", - "CreateDBInstanceMessage$CopyTagsToSnapshot": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
", - "CreateDBInstanceMessage$EnableIAMDatabaseAuthentication": "A value that indicates 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 RDS Custom.
Amazon Aurora
Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
", - "CreateDBInstanceMessage$EnablePerformanceInsights": "A value that indicates 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.
", - "CreateDBInstanceMessage$DeletionProtection": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
A value that indicates 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.
", - "CreateDBInstanceMessage$ManageMasterUserPassword": "A value that indicates 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.
Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", + "CreateDBClusterMessage$EnableIAMDatabaseAuthentication": "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
", + "CreateDBClusterMessage$DeletionProtection": "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
", + "CreateDBClusterMessage$EnableHttpEndpoint": "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
", + "CreateDBClusterMessage$CopyTagsToSnapshot": "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
", + "CreateDBClusterMessage$EnableGlobalWriteForwarding": "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
", + "CreateDBClusterMessage$PubliclyAccessible": "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.
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
", + "CreateDBClusterMessage$EnablePerformanceInsights": "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
", + "CreateDBClusterMessage$ManageMasterUserPassword": "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.
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
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.
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.
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.
", + "CreateDBInstanceMessage$CopyTagsToSnapshot": "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.
", + "CreateDBInstanceMessage$EnableIAMDatabaseAuthentication": "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
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.
", + "CreateDBInstanceMessage$DeletionProtection": "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.
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.
", + "CreateDBInstanceMessage$ManageMasterUserPassword": "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.
A value that indicates whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source is a Multi-AZ DB instance or a Multi-AZ DB cluster.
This setting doesn't apply to RDS Custom.
", "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
This setting doesn't apply to RDS Custom.
Default: Inherits from the source DB instance
", "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "A value that 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.
", @@ -551,18 +551,18 @@ "CreateEventSubscriptionMessage$Enabled": "A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
", "CreateGlobalClusterMessage$DeletionProtection": "The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
", "CreateGlobalClusterMessage$StorageEncrypted": "The storage encryption setting for the new global database cluster.
", - "DBCluster$MultiAZ": "Specifies whether the DB cluster has instances in multiple Availability Zones.
", - "DBCluster$IAMDatabaseAuthenticationEnabled": "A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", - "DBCluster$DeletionProtection": "Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
", - "DBCluster$HttpEndpointEnabled": "A value that 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.
", - "DBCluster$CopyTagsToSnapshot": "Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
", - "DBCluster$CrossAccountClone": "Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
", - "DBCluster$GlobalWriteForwardingRequested": "Specifies whether you have requested to enable write forwarding 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.
Specifies the accessibility options for the DB instance.
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.
For more information, see CreateDBInstance.
This setting is only for non-Aurora Multi-AZ DB clusters.
", - "DBCluster$PerformanceInsightsEnabled": "True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
", + "DBCluster$MultiAZ": "Indicates whether the DB cluster has instances in multiple Availability Zones.
", + "DBCluster$IAMDatabaseAuthenticationEnabled": "Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
", + "DBCluster$DeletionProtection": "Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
", + "DBCluster$HttpEndpointEnabled": "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.
", + "DBCluster$CopyTagsToSnapshot": "Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
", + "DBCluster$CrossAccountClone": "Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
", + "DBCluster$GlobalWriteForwardingRequested": "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.
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.
", + "DBCluster$PerformanceInsightsEnabled": "Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
", "DBEngineVersion$SupportsCertificateRotationWithoutRestart": "A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
", - "DBInstance$PerformanceInsightsEnabled": "True if Performance Insights is enabled for the DB instance, and otherwise false.
", - "DBInstance$CustomerOwnedIpEnabled": "Specifies 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.
", + "DBInstance$PerformanceInsightsEnabled": "Indicates whether Performance Insights is enabled for the DB instance.
", + "DBInstance$CustomerOwnedIpEnabled": "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.
", "DBInstance$ActivityStreamEngineNativeAuditFieldsIncluded": "Indicates whether engine-native audit fields are included in the database activity stream.
", "DeleteBlueGreenDeploymentRequest$DeleteTarget": "A value that indicates whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.
A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
", @@ -576,27 +576,27 @@ "GlobalCluster$DeletionProtection": "The deletion protection setting for the new global database cluster.
", "ModifyActivityStreamResponse$EngineNativeAuditFieldsIncluded": "Indicates whether engine-native audit fields are included in the database activity stream.
", "ModifyCertificatesMessage$RemoveCustomerOverride": "A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
", - "ModifyDBClusterMessage$EnableIAMDatabaseAuthentication": "A value that indicates 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: Aurora DB clusters only
", - "ModifyDBClusterMessage$DeletionProtection": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$EnableHttpEndpoint": "A value that indicates 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: Aurora DB clusters only
", - "ModifyDBClusterMessage$CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$EnableGlobalWriteForwarding": "A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). 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 the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
", - "ModifyDBClusterMessage$AutoMinorVersionUpgrade": "A value that indicates 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: Multi-AZ DB clusters only
", - "ModifyDBClusterMessage$EnablePerformanceInsights": "A value that indicates 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: Multi-AZ DB clusters only
", - "ModifyDBClusterMessage$ManageMasterUserPassword": "A value that indicates 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: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$RotateMasterUserPassword": "A value that indicates 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.
Constraints:
You must apply the change immediately when rotating the master user password.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBInstanceMessage$MultiAZ": "A value that indicates 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.
", - "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "A value that indicates 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, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. Otherwise, the operation returns an error.
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.
A value that 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.
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.
A value that indicates 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.
", - "ModifyDBInstanceMessage$EnablePerformanceInsights": "A value that indicates 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.
", - "ModifyDBInstanceMessage$UseDefaultProcessorFeatures": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
", - "ModifyDBInstanceMessage$DeletionProtection": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
", - "ModifyDBInstanceMessage$CertificateRotationRestart": "A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
", - "ModifyDBInstanceMessage$EnableCustomerOwnedIp": "A value that indicates 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.
", - "ModifyDBInstanceMessage$ManageMasterUserPassword": "A value that indicates 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, 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.
A value that indicates 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.
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
", + "ModifyDBClusterMessage$DeletionProtection": "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
", + "ModifyDBClusterMessage$EnableHttpEndpoint": "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
", + "ModifyDBClusterMessage$CopyTagsToSnapshot": "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
", + "ModifyDBClusterMessage$EnableGlobalWriteForwarding": "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
", + "ModifyDBClusterMessage$AutoMinorVersionUpgrade": "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
", + "ModifyDBClusterMessage$EnablePerformanceInsights": "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
", + "ModifyDBClusterMessage$ManageMasterUserPassword": "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
", + "ModifyDBClusterMessage$RotateMasterUserPassword": "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.
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.
", + "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "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.
", + "ModifyDBInstanceMessage$CopyTagsToSnapshot": "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.
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.
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.
", + "ModifyDBInstanceMessage$EnablePerformanceInsights": "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.
", + "ModifyDBInstanceMessage$UseDefaultProcessorFeatures": "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.
", + "ModifyDBInstanceMessage$DeletionProtection": "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.
", + "ModifyDBInstanceMessage$CertificateRotationRestart": "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.
", + "ModifyDBInstanceMessage$EnableCustomerOwnedIp": "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.
", + "ModifyDBInstanceMessage$ManageMasterUserPassword": "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.
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.
Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
", "ModifyDBProxyRequest$DebugLogging": "Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
", "ModifyEventSubscriptionMessage$Enabled": "A value that indicates whether to activate the subscription.
", @@ -722,14 +722,14 @@ "CloudwatchLogsExportConfiguration": { "base": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.
For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
", "refs": { - "ModifyDBClusterMessage$CloudwatchLogsExportConfiguration": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBInstanceMessage$CloudwatchLogsExportConfiguration": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
" + "ModifyDBClusterMessage$CloudwatchLogsExportConfiguration": "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.
", + "ModifyDBInstanceMessage$CloudwatchLogsExportConfiguration": "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.
" } }, "ClusterPendingModifiedValues": { "base": "This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" + "DBCluster$PendingModifiedValues": "Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
" } }, "ConnectionPoolConfiguration": { @@ -1116,7 +1116,7 @@ "DBClusterMemberList": { "base": null, "refs": { - "DBCluster$DBClusterMembers": "Provides the list of instances that make up the DB cluster.
" + "DBCluster$DBClusterMembers": "The list of DB instances that make up the DB cluster.
" } }, "DBClusterMessage": { @@ -1132,7 +1132,7 @@ "DBClusterOptionGroupMemberships": { "base": null, "refs": { - "DBCluster$DBClusterOptionGroupMemberships": "Provides the list of option group memberships for this DB cluster.
" + "DBCluster$DBClusterOptionGroupMemberships": "The list of option group memberships for this DB cluster.
" } }, "DBClusterOptionGroupStatus": { @@ -1204,7 +1204,7 @@ "DBClusterRoles": { "base": null, "refs": { - "DBCluster$AssociatedRoles": "Provides 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.
" + "DBCluster$AssociatedRoles": "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.
" } }, "DBClusterSnapshot": { @@ -1391,7 +1391,7 @@ "DBInstanceStatusInfoList": { "base": null, "refs": { - "DBInstance$StatusInfos": "The status of a read replica. If the instance isn't a read replica, this is blank.
" + "DBInstance$StatusInfos": "The status of a read replica. If the DB instance isn't a read replica, the value is blank.
" } }, "DBLogFileNotFoundFault": { @@ -1447,7 +1447,7 @@ "DBParameterGroupStatusList": { "base": null, "refs": { - "DBInstance$DBParameterGroups": "Provides the list of DB parameter groups applied to this DB instance.
" + "DBInstance$DBParameterGroups": "The list of DB parameter groups applied to this DB instance.
" } }, "DBParameterGroupsMessage": { @@ -1615,7 +1615,7 @@ "base": null, "refs": { "CreateDBInstanceMessage$DBSecurityGroups": "A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
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 DBSecurityGroups.
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.
A list of DBSecurityGroupMembership name strings used for this option.
", "RestoreDBInstanceFromS3Message$DBSecurityGroups": "A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
" } @@ -1695,7 +1695,7 @@ "base": "Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
", + "DBInstance$DBSubnetGroup": "Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
", "DBSubnetGroups$member": null, "ModifyDBSubnetGroupResult$DBSubnetGroup": null } @@ -2256,8 +2256,8 @@ "Endpoint": { "base": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
CreateDBInstance
DescribeDBInstances
DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
Specifies the connection endpoint.
The endpoint might not be shown for instances whose status is creating.
Specifies the listener connection endpoint for SQL Server Always On.
" + "DBInstance$Endpoint": "The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating.
The listener connection endpoint for SQL Server Always On.
" } }, "EngineDefaults": { @@ -2442,10 +2442,10 @@ "DescribeDBClusterParameterGroupsMessage$Filters": "This parameter isn't currently supported.
", "DescribeDBClusterParametersMessage$Filters": "This parameter isn't currently supported.
", "DescribeDBClusterSnapshotsMessage$Filters": "A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster snapshots.
engine - Accepts names of database engines.
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.
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.
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
available
deprecated
A filter that specifies which resources to return based on status.
Supported filters are the following:
status
active - automated backups for current instances
retained - automated backups for deleted instances and after backup replication is stopped
creating - automated backups that are waiting for the first automated snapshot to be available
db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.
dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.
Returns all resources by default. The status for each resource is specified in the response.
", - "DescribeDBInstancesMessage$Filters": "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 will only include 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.
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.
This parameter isn't currently supported.
", "DescribeDBParameterGroupsMessage$Filters": "This parameter isn't currently supported.
", "DescribeDBParametersMessage$Filters": "This parameter isn't currently supported.
", @@ -2597,9 +2597,9 @@ "DBClusterSnapshot$AllocatedStorage": "Specifies the allocated storage size in gibibytes (GiB).
", "DBClusterSnapshot$Port": "Specifies the port that the DB cluster was listening on at the time of the snapshot.
", "DBClusterSnapshot$PercentProgress": "Specifies the percentage of the estimated data that has been transferred.
", - "DBInstance$AllocatedStorage": "Specifies the allocated storage size specified in gibibytes (GiB).
", - "DBInstance$BackupRetentionPeriod": "Specifies the number of days for which automatic DB snapshots are retained.
", - "DBInstance$DbInstancePort": "Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
", + "DBInstance$AllocatedStorage": "The amount of storage in gibibytes (GiB) allocated for the DB instance.
", + "DBInstance$BackupRetentionPeriod": "The number of days for which automatic DB snapshots are retained.
", + "DBInstance$DbInstancePort": "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.
", "DBInstanceAutomatedBackup$AllocatedStorage": "Specifies the allocated storage size in gibibytes (GiB).
", "DBInstanceAutomatedBackup$Port": "The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
", @@ -2627,21 +2627,21 @@ "ConnectionPoolConfiguration$MaxConnectionsPercent": "The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.
Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines
Constraints: Must be between 1 and 100.
", "ConnectionPoolConfiguration$MaxIdleConnectionsPercent": "Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
If you specify this parameter, then you must also include a value for MaxConnectionsPercent.
Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.
Constraints: Must be between 0 and the value of MaxConnectionsPercent.
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
Default: 120
Constraints: between 1 and 3600, or 0 representing unlimited
", - "CreateDBClusterMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$Port": "The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$AllocatedStorage": "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.
Valid for: Multi-AZ DB clusters only
", - "CreateDBClusterMessage$Iops": "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: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
", - "CreateDBClusterMessage$MonitoringInterval": "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. The default is 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
", - "CreateDBClusterMessage$PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
Valid for: Multi-AZ DB clusters only
", - "CreateDBInstanceMessage$AllocatedStorage": "The amount of storage in gibibytes (GiB) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
Amazon RDS Custom
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.
MySQL
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.
MariaDB
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.
PostgreSQL
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.
Oracle
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.
SQL Server
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.
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to read replicas
Can't be set to 0 for an RDS Custom for Oracle DB instance
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
", - "CreateDBInstanceMessage$Iops": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
", - "CreateDBInstanceMessage$MonitoringInterval": "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. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
", - "CreateDBInstanceMessage$PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceMessage$MaxAllocatedStorage": "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.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
", - "CreateDBInstanceMessage$StorageThroughput": "Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
", + "CreateDBClusterMessage$BackupRetentionPeriod": "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.
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
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.
", + "CreateDBClusterMessage$Iops": "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.
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
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.
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.
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.
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.
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.
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.
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
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
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.
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
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.
", "CreateDBInstanceReadReplicaMessage$Port": "The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
", "CreateDBInstanceReadReplicaMessage$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth.
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
", "DBCluster$AllocatedStorage": "For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
Specifies the number of days for which automatic DB snapshots are retained.
", - "DBCluster$Port": "Specifies the port that the database engine is listening on.
", - "DBCluster$Capacity": "The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
", + "DBCluster$BackupRetentionPeriod": "The number of days for which automatic DB snapshots are retained.
", + "DBCluster$Port": "The port that the database engine is listening on.
", + "DBCluster$Capacity": "The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
", "DBCluster$Iops": "The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
", "DBCluster$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
", - "DBCluster$PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
This setting is only for non-Aurora Multi-AZ DB clusters.
", + "DBCluster$PerformanceInsightsRetentionPeriod": "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
A value that specifies the capacity that the DB cluster scales to next.
", "DBClusterCapacityInfo$CurrentCapacity": "The current capacity of the DB cluster.
", "DBClusterCapacityInfo$SecondsBeforeTimeout": "The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
", - "DBInstance$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value.
", + "DBInstance$Iops": "The Provisioned IOPS (I/O operations per second) value for the DB instance.
", "DBInstance$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
", - "DBInstance$PromotionTier": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
", - "DBInstance$PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
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.
", + "DBInstance$PerformanceInsightsRetentionPeriod": "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
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
", - "DBInstance$StorageThroughput": "Specifies the storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
The storage throughput for the DB instance.
This setting applies only to the gp3 storage type.
The IOPS (I/O operations per second) value for the automated backup.
", "DBInstanceAutomatedBackup$BackupRetentionPeriod": "The retention period for the automated backups.
", "DBInstanceAutomatedBackup$StorageThroughput": "Specifies the storage throughput for the automated backup.
", @@ -2703,22 +2703,22 @@ "DescribeSourceRegionsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
", "ModifyCurrentDBClusterCapacityMessage$Capacity": "The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.
For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
", - "ModifyDBClusterMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. Specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$Port": "The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters only
", - "ModifyDBClusterMessage$AllocatedStorage": "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
", - "ModifyDBClusterMessage$Iops": "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: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
", - "ModifyDBClusterMessage$MonitoringInterval": "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. The default is 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
", - "ModifyDBClusterMessage$PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
Valid for: Multi-AZ DB clusters only
", - "ModifyDBInstanceMessage$AllocatedStorage": "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.
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.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints:
It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 for an RDS Custom for Oracle DB instance.
It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later.
It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
", - "ModifyDBInstanceMessage$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
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.
MySQL
Default: 3306
Valid values: 1150-65535
MariaDB
Default: 3306
Valid values: 1150-65535
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
", - "ModifyDBInstanceMessage$PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
", - "ModifyDBInstanceMessage$MaxAllocatedStorage": "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.
", - "ModifyDBInstanceMessage$ResumeFullAutomationModeMinutes": "The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
", + "ModifyDBClusterMessage$BackupRetentionPeriod": "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.
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.
", + "ModifyDBClusterMessage$AllocatedStorage": "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
", + "ModifyDBClusterMessage$Iops": "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.
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
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.
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.
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.
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
", + "ModifyDBInstanceMessage$MonitoringInterval": "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
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.
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
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.
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.
", + "ModifyDBInstanceMessage$ResumeFullAutomationModeMinutes": "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.
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.
", "ModifyDBProxyRequest$IdleClientTimeout": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
", "Option$Port": "If required, the port configured for this option to use.
", "OptionConfiguration$Port": "The optional port for the option.
", @@ -2928,12 +2928,12 @@ "refs": { "CloudwatchLogsExportConfiguration$EnableLogTypes": "The list of log types to enable.
", "CloudwatchLogsExportConfiguration$DisableLogTypes": "The list of log types to disable.
", - "CreateDBClusterMessage$EnableCloudwatchLogsExports": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error, general, and slowquery.
RDS for PostgreSQL
Possible values are postgresql and upgrade.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
Aurora PostgreSQL
Possible value is postgresql.
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBInstanceMessage$EnableCloudwatchLogsExports": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
RDS Custom
Not applicable.
MariaDB
Possible values are audit, error, general, and slowquery.
Microsoft SQL Server
Possible values are agent and error.
MySQL
Possible values are audit, error, general, and slowquery.
Oracle
Possible values are alert, audit, listener, trace, and oemagent.
PostgreSQL
Possible values are postgresql and upgrade.
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.
", + "CreateDBInstanceMessage$EnableCloudwatchLogsExports": "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
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
", "DBCluster$EnabledCloudwatchLogsExports": "A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
", "DBEngineVersion$ExportableLogTypes": "The types of logs that the database engine has available for export to CloudWatch Logs.
", - "DBInstance$EnabledCloudwatchLogsExports": "A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
", + "DBInstance$EnabledCloudwatchLogsExports": "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.
", "PendingCloudwatchLogsExports$LogTypesToEnable": "Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
", "PendingCloudwatchLogsExports$LogTypesToDisable": "Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
", "RestoreDBClusterFromS3Message$EnableCloudwatchLogsExports": "The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are audit, error, general, and slowquery.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
", @@ -2958,10 +2958,10 @@ "LongOptional": { "base": null, "refs": { - "CreateDBClusterMessage$BacktrackWindow": "The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
", - "DBCluster$BacktrackWindow": "The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
", + "CreateDBClusterMessage$BacktrackWindow": "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).
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
The number of change records stored for Backtrack.
", - "ModifyDBClusterMessage$BacktrackWindow": "The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
", + "ModifyDBClusterMessage$BacktrackWindow": "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).
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora DB clusters only
", "RestoreDBClusterToPointInTimeMessage$BacktrackWindow": "The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
" @@ -2970,8 +2970,8 @@ "MasterUserSecret": { "base": "Contains 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.
", "refs": { - "DBCluster$MasterUserSecret": "Contains 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.
", - "DBInstance$MasterUserSecret": "Contains 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.
" + "DBCluster$MasterUserSecret": "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.
", + "DBInstance$MasterUserSecret": "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.
" } }, "MaxRecords": { @@ -3208,7 +3208,7 @@ "OptionGroupMembershipList": { "base": null, "refs": { - "DBInstance$OptionGroupMemberships": "Provides the list of option group memberships for this DB instance.
" + "DBInstance$OptionGroupMemberships": "The list of option group memberships for this DB instance.
" } }, "OptionGroupNotFoundFault": { @@ -3390,7 +3390,7 @@ "PendingModifiedValues": { "base": "This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
" + "DBInstance$PendingModifiedValues": "Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
" } }, "PointInTimeRestoreNotEnabledFault": { @@ -3407,11 +3407,11 @@ "ProcessorFeatureList": { "base": null, "refs": { - "CreateDBInstanceMessage$ProcessorFeatures": "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.
Amazon Aurora
Not applicable.
", + "CreateDBInstanceMessage$ProcessorFeatures": "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.
", "CreateDBInstanceReadReplicaMessage$ProcessorFeatures": "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.
", "DBInstance$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
", "DBSnapshot$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
", - "ModifyDBInstanceMessage$ProcessorFeatures": "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.
", + "ModifyDBInstanceMessage$ProcessorFeatures": "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.
", "PendingModifiedValues$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
", "RestoreDBInstanceFromDBSnapshotMessage$ProcessorFeatures": "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.
", "RestoreDBInstanceFromS3Message$ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
", @@ -3470,13 +3470,13 @@ "ReadReplicaDBClusterIdentifierList": { "base": null, "refs": { - "DBInstance$ReadReplicaDBClusterIdentifiers": "Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS 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.
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.
Contains one or more identifiers of the read replicas associated with this DB instance.
" + "DBInstance$ReadReplicaDBInstanceIdentifiers": "The identifiers of the read replicas associated with this DB instance.
" } }, "ReadReplicaIdentifierList": { @@ -3574,7 +3574,7 @@ "refs": { "CreateDBInstanceReadReplicaMessage$ReplicaMode": "The open mode of the replica database: mounted or read-only.
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Database 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.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually.
The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
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.
" + "ModifyDBInstanceMessage$ReplicaMode": "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.
" } }, "ReservedDBInstance": { @@ -3748,14 +3748,14 @@ "ScalingConfiguration": { "base": "Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
", "refs": { - "CreateDBClusterMessage$ScalingConfiguration": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
", - "ModifyDBClusterMessage$ScalingConfiguration": "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
", + "CreateDBClusterMessage$ScalingConfiguration": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for Cluster Type: Aurora DB clusters only
", + "ModifyDBClusterMessage$ScalingConfiguration": "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
", "RestoreDBClusterFromSnapshotMessage$ScalingConfiguration": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
", "RestoreDBClusterToPointInTimeMessage$ScalingConfiguration": "For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
" } }, "ScalingConfigurationInfo": { - "base": "Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
", + "base": "The scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
", "refs": { "DBCluster$ScalingConfigurationInfo": null } @@ -3771,7 +3771,7 @@ } }, "ServerlessV2ScalingConfigurationInfo": { - "base": "Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
", + "base": "The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
", "refs": { "DBCluster$ServerlessV2ScalingConfiguration": null } @@ -3999,68 +3999,68 @@ "CreateDBClusterEndpointMessage$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", "CreateDBClusterEndpointMessage$DBClusterEndpointIdentifier": "The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
", "CreateDBClusterEndpointMessage$EndpointType": "The type of the endpoint, one of: READER, WRITER, ANY.
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
", - "CreateDBClusterMessage$DatabaseName": "The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$DBClusterIdentifier": "The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$DBClusterParameterGroupName": "The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
If supplied, must match the name of an existing DB cluster parameter group.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$DBSubnetGroupName": "A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$Engine": "The name of the database engine to be used for this DB cluster.
Valid Values:
aurora-mysql
aurora-postgresql
mysql
postgres
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$EngineVersion": "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\"
Aurora MySQL
For information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.
Aurora PostgreSQL
For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
For information, see Amazon RDS for MySQL in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$MasterUsername": "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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$MasterUserPassword": "The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$OptionGroupName": "A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
", - "CreateDBClusterMessage$PreferredBackupWindow": "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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each 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.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$ReplicationSourceIdentifier": "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
", - "CreateDBClusterMessage$KmsKeyId": "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 will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use 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, you must 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: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBClusterMessage$PreSignedUrl": "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 only
", - "CreateDBClusterMessage$EngineMode": "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:
Valid for: Aurora DB clusters only
", - "CreateDBClusterMessage$GlobalClusterIdentifier": "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
", - "CreateDBClusterMessage$Domain": "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
", - "CreateDBClusterMessage$DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
", - "CreateDBClusterMessage$DBClusterInstanceClass": "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
", - "CreateDBClusterMessage$StorageType": "Specifies the storage type to be associated with the DB cluster.
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 values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
For more information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For more information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
", - "CreateDBClusterMessage$MonitoringRoleArn": "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
", - "CreateDBClusterMessage$PerformanceInsightsKMSKeyId": "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
", - "CreateDBClusterMessage$NetworkType": "The network type of the DB cluster.
Valid values:
IPV4
DUAL
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: Aurora DB clusters only
", + "CreateDBClusterMessage$CharacterSetName": "The name of the character set (CharacterSet) to associate the DB cluster with.
Valid for Cluster Type: Aurora DB clusters only
", + "CreateDBClusterMessage$DatabaseName": "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
", + "CreateDBClusterMessage$DBClusterIdentifier": "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
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.
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
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
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
", + "CreateDBClusterMessage$MasterUsername": "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.
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.
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
", + "CreateDBClusterMessage$PreferredBackupWindow": "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.
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.
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
", + "CreateDBClusterMessage$KmsKeyId": "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
", + "CreateDBClusterMessage$PreSignedUrl": "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 only
", + "CreateDBClusterMessage$EngineMode": "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:
Valid for Cluster Type: Aurora DB clusters only
", + "CreateDBClusterMessage$GlobalClusterIdentifier": "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
", + "CreateDBClusterMessage$Domain": "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
", + "CreateDBClusterMessage$DomainIAMRoleName": "The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
", + "CreateDBClusterMessage$DBClusterInstanceClass": "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
", + "CreateDBClusterMessage$StorageType": "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
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
", + "CreateDBClusterMessage$PerformanceInsightsKMSKeyId": "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
", + "CreateDBClusterMessage$NetworkType": "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
Reserved for future use.
", - "CreateDBClusterMessage$MasterUserSecretKmsKeyId": "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
", + "CreateDBClusterMessage$MasterUserSecretKmsKeyId": "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
", "CreateDBClusterParameterGroupMessage$DBClusterParameterGroupName": "The name of the DB cluster parameter group.
Constraints:
Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora-mysql5.7, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql14
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres12
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mysql
postgres
The description for the DB cluster parameter group.
", "CreateDBClusterSnapshotMessage$DBClusterSnapshotIdentifier": "The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1-snapshot1
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
Example: my-cluster1
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance.
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 specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL
Constraints:
Can't be longer than 8 characters
Amazon RDS Custom for Oracle
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL.
Default: ORCL
Constraints:
It must contain 1 to 8 alphanumeric characters.
It must contain a letter.
It can't be a word reserved by the database engine.
Amazon RDS Custom for SQL Server
Not applicable. Must be null.
SQL Server
Not applicable. Must be null.
Amazon Aurora MySQL
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
It must contain 1 to 64 alphanumeric characters.
It can't be a word reserved by the database engine.
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.
Constraints:
It must contain 1 to 63 alphanumeric characters.
It must begin with a letter. Subsequent characters can be letters, underscores, or digits (0 to 9).
It can't be a word reserved by the database engine.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The compute and memory capacity of the DB instance, for example db.m5.large. 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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
", - "CreateDBInstanceMessage$Engine": "The name of the database engine to be used for this instance.
Not every database engine is available for 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
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
Amazon RDS
Constraints:
Required.
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.
The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
Constraints: Can't be specified if ManageMasterUserPassword is turned on.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
", - "CreateDBInstanceMessage$AvailabilityZone": "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.
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.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
", - "CreateDBInstanceMessage$DBParameterGroupName": "The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
This setting doesn't apply to RDS Custom.
Constraints:
It must be 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
It can't end with a hyphen or contain two consecutive hyphens.
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.
Amazon Aurora
Not applicable. 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.
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 Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
Amazon RDS Custom for Oracle
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.
Amazon RDS Custom for SQL Server
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.
MariaDB
For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
", - "CreateDBInstanceMessage$LicenseModel": "License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
", - "CreateDBInstanceMessage$OptionGroupName": "A value that indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
", - "CreateDBInstanceMessage$CharacterSetName": "For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.
This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn't apply to RDS Custom.
", - "CreateDBInstanceMessage$DBClusterIdentifier": "The identifier of the DB cluster that the instance will belong to.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceMessage$StorageType": "Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
", - "CreateDBInstanceMessage$TdeCredentialArn": "The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
", - "CreateDBInstanceMessage$TdeCredentialPassword": "The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
", - "CreateDBInstanceMessage$KmsKeyId": "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.
Amazon Aurora
Not applicable. 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.
Amazon RDS Custom
A KMS key is required for RDS Custom 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.
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, 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 RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
", - "CreateDBInstanceMessage$MonitoringRoleArn": "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.
", - "CreateDBInstanceMessage$DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
", + "CreateDBInstanceMessage$DBName": "The meaning of this parameter differs depending on the database engine.
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.
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
The compute and memory capacity of the DB instance, for example db.m5.large. 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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
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
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.
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.
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
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
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.
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.
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.
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.
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.
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
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.
", + "CreateDBInstanceMessage$CharacterSetName": "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.
The name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceMessage$DBClusterIdentifier": "The identifier of the DB cluster that this DB instance will belong to.
This setting doesn't apply to RDS Custom DB instances.
", + "CreateDBInstanceMessage$StorageType": "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.
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.
", + "CreateDBInstanceMessage$TdeCredentialPassword": "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.
", + "CreateDBInstanceMessage$KmsKeyId": "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.
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
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.
", + "CreateDBInstanceMessage$DomainIAMRoleName": "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
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
", - "CreateDBInstanceMessage$PerformanceInsightsKMSKeyId": "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 do not 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.
", - "CreateDBInstanceMessage$CustomIamInstanceProfile": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
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.
This setting is required for RDS Custom.
", - "CreateDBInstanceMessage$BackupTarget": "Specifies where automated backups and manual snapshots are stored.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
", - "CreateDBInstanceMessage$NetworkType": "The network type of the DB instance.
Valid values:
IPV4
DUAL
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.
", + "CreateDBInstanceMessage$PerformanceInsightsKMSKeyId": "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.
", + "CreateDBInstanceMessage$CustomIamInstanceProfile": "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.
", + "CreateDBInstanceMessage$BackupTarget": "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.
", + "CreateDBInstanceMessage$NetworkType": "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
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 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.
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.
", - "CreateDBInstanceMessage$CACertificateIdentifier": "Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
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.
", + "CreateDBInstanceMessage$CACertificateIdentifier": "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.
", "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
", "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.
Can't be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
The compute and memory capacity of the read replica, for example db.m4.large. 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.
Default: Inherits from the source DB instance.
", @@ -4104,25 +4104,25 @@ "CustomDBEngineVersionAMI$ImageId": "A value that indicates the ID of the AMI.
", "CustomDBEngineVersionAMI$Status": "A value that indicates the status of a custom engine version (CEV).
", "DBCluster$CharacterSetName": "If present, specifies the name of the character set that this cluster is associated with.
", - "DBCluster$DatabaseName": "Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
", - "DBCluster$DBClusterIdentifier": "Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
", - "DBCluster$DBClusterParameterGroup": "Specifies the name of the DB cluster parameter group for the DB cluster.
", - "DBCluster$DBSubnetGroup": "Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
", - "DBCluster$Status": "Specifies the current state of this DB cluster.
", - "DBCluster$PercentProgress": "Specifies the progress of the operation as a percentage.
", - "DBCluster$Endpoint": "Specifies the connection endpoint for the primary instance of the DB cluster.
", + "DBCluster$DatabaseName": "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.
", + "DBCluster$DBClusterIdentifier": "The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
", + "DBCluster$DBClusterParameterGroup": "The name of the DB cluster parameter group for the DB cluster.
", + "DBCluster$DBSubnetGroup": "Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
", + "DBCluster$Status": "The current state of this DB cluster.
", + "DBCluster$PercentProgress": "The progress of the operation as a percentage.
", + "DBCluster$Endpoint": "The connection endpoint for the primary instance of the DB cluster.
", "DBCluster$ReaderEndpoint": "The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
", - "DBCluster$Engine": "The name of the database engine to be used for this DB cluster.
", - "DBCluster$EngineVersion": "Indicates the database engine version.
", - "DBCluster$MasterUsername": "Contains the master username for the DB cluster.
", - "DBCluster$PreferredBackupWindow": "Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
", - "DBCluster$ReplicationSourceIdentifier": "Contains the identifier of the source DB cluster if this DB cluster is a read replica.
", - "DBCluster$HostedZoneId": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
", + "DBCluster$Engine": "The database engine used for this DB cluster.
", + "DBCluster$EngineVersion": "The version of the database engine.
", + "DBCluster$MasterUsername": "The master username for the DB cluster.
", + "DBCluster$PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
", + "DBCluster$ReplicationSourceIdentifier": "The identifier of the source DB cluster if this DB cluster is a read replica.
", + "DBCluster$HostedZoneId": "The ID that Amazon Route 53 assigns when you create a hosted zone.
", "DBCluster$KmsKeyId": "If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the 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.
", "DBCluster$DbClusterResourceId": "The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
", "DBCluster$DBClusterArn": "The Amazon Resource Name (ARN) for the DB cluster.
", - "DBCluster$CloneGroupId": "Identifies the clone group to which the DB cluster is associated.
", + "DBCluster$CloneGroupId": "The ID of the clone group with which the DB cluster is associated.
", "DBCluster$EngineMode": "The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
", "DBCluster$ActivityStreamKmsKeyId": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
", "DBCluster$ActivityStreamKinesisStreamName": "The name of the Amazon Kinesis data stream used for the database activity stream.
", @@ -4130,7 +4130,7 @@ "DBCluster$StorageType": "The storage type associated with the DB cluster.
", "DBCluster$MonitoringRoleArn": "The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
", "DBCluster$PerformanceInsightsKMSKeyId": "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.
This setting is only for non-Aurora Multi-AZ DB clusters.
", - "DBCluster$NetworkType": "The network type of the DB instance.
Valid values:
IPV4
DUAL
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.
", + "DBCluster$NetworkType": "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
Reserved for future use.
", "DBClusterBacktrack$DBClusterIdentifier": "Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
", "DBClusterBacktrack$BacktrackIdentifier": "Contains the backtrack identifier.
", @@ -4149,7 +4149,7 @@ "DBClusterEndpointMessage$Marker": "An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the instance identifier for this member of the DB cluster.
", "DBClusterMember$DBClusterParameterGroupStatus": "Specifies the status of the DB cluster parameter group for this member of the DB cluster.
", - "DBClusterMessage$Marker": "A pagination token that can be used in a later DescribeDBClusters request.
", + "DBClusterMessage$Marker": "A pagination token that can be used in a later DescribeDBClusters request.
Specifies the name of the DB cluster option group.
", "DBClusterOptionGroupStatus$Status": "Specifies the status of the DB cluster option group.
", "DBClusterParameterGroup$DBClusterParameterGroupName": "The name of the DB cluster parameter group.
", @@ -4193,25 +4193,25 @@ "DBEngineVersion$DBEngineVersionArn": "The ARN of the custom engine version.
", "DBEngineVersion$KMSKeyId": "The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
", "DBEngineVersionMessage$Marker": "An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
", - "DBInstance$DBInstanceClass": "Contains the name of the compute and memory capacity class of the DB instance.
", - "DBInstance$Engine": "The name of the database engine to be used for this DB instance.
", - "DBInstance$DBInstanceStatus": "Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
", - "DBInstance$MasterUsername": "Contains the master username for the DB instance.
", - "DBInstance$DBName": "The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
", - "DBInstance$PreferredBackupWindow": "Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Specifies the name of the Availability Zone the DB instance is located in.
", - "DBInstance$PreferredMaintenanceWindow": "Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
", - "DBInstance$EngineVersion": "Indicates the database engine version.
", - "DBInstance$ReadReplicaSourceDBInstanceIdentifier": "Contains the identifier of the source DB instance if this DB instance is a read replica.
", - "DBInstance$LicenseModel": "License model information for this DB instance. This setting doesn't apply to RDS Custom.
", + "DBInstance$DBInstanceIdentifier": "The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
", + "DBInstance$DBInstanceClass": "The name of the compute and memory capacity class of the DB instance.
", + "DBInstance$Engine": "The database engine used for this DB instance.
", + "DBInstance$DBInstanceStatus": "The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
", + "DBInstance$MasterUsername": "The master username for the DB instance.
", + "DBInstance$DBName": "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.
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
The name of the Availability Zone where the DB instance is located.
", + "DBInstance$PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
", + "DBInstance$EngineVersion": "The version of the database engine.
", + "DBInstance$ReadReplicaSourceDBInstanceIdentifier": "The identifier of the source DB instance if this DB instance is a read replica.
", + "DBInstance$LicenseModel": "The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
", "DBInstance$CharacterSetName": "If present, specifies the name of the character set that this instance is associated with.
", "DBInstance$NcharCharacterSetName": "The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
", "DBInstance$SecondaryAvailabilityZone": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
", - "DBInstance$StorageType": "Specifies the storage type associated with the DB instance.
", + "DBInstance$StorageType": "The storage type associated with the DB instance.
", "DBInstance$TdeCredentialArn": "The ARN from the key store with which the instance is associated for TDE encryption.
", - "DBInstance$DBClusterIdentifier": "If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
", - "DBInstance$KmsKeyId": "If StorageEncrypted is true, 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.
", + "DBInstance$DBClusterIdentifier": "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.
", + "DBInstance$KmsKeyId": "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.
", "DBInstance$DbiResourceId": "The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
", "DBInstance$CACertificateIdentifier": "The identifier of the CA certificate for this DB instance.
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.
", "DBInstance$EnhancedMonitoringResourceArn": "The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
", @@ -4223,10 +4223,10 @@ "DBInstance$ActivityStreamKmsKeyId": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
", "DBInstance$ActivityStreamKinesisStreamName": "The name of the Amazon Kinesis data stream used for the database activity stream.
", "DBInstance$CustomIamInstanceProfile": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
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.
", - "DBInstance$BackupTarget": "Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
", - "DBInstance$NetworkType": "The network type of the DB instance.
Valid values:
IPV4
DUAL
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.
", - "DBInstance$DBSystemId": "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 only.
", - "DBInstance$ReadReplicaSourceDBClusterIdentifier": "Contains the identifier of the source DB cluster if this DB instance is a read replica.
", + "DBInstance$BackupTarget": "The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
", + "DBInstance$NetworkType": "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
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.
", + "DBInstance$ReadReplicaSourceDBClusterIdentifier": "The identifier of the source DB cluster if this DB instance is a read replica.
", "DBInstanceAutomatedBackup$DBInstanceArn": "The Amazon Resource Name (ARN) for the automated backups.
", "DBInstanceAutomatedBackup$DbiResourceId": "The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
", "DBInstanceAutomatedBackup$Region": "The Amazon Web Services Region associated with the automated backup.
", @@ -4359,7 +4359,7 @@ "DescribeDBClusterSnapshotsMessage$DBClusterSnapshotIdentifier": "A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DBClusterIdentifier.
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.
An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The database engine to return.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The database engine version to return.
Example: 5.1.49
(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.
", "DescribeDBInstanceAutomatedBackupsMessage$Marker": "The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
", - "DescribeDBInstancesMessage$DBInstanceIdentifier": "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 DBInstance.
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.
An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of the log file for the specified DB instance.
", "DescribeDBLogFilesMessage$DBInstanceIdentifier": "The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
Must match the identifier of an existing DBInstance.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
", "ModifyDBClusterEndpointMessage$EndpointType": "The type of the endpoint. One of: READER, WRITER, ANY.
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$NewDBClusterIdentifier": "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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$DBClusterParameterGroupName": "The name of the DB cluster parameter group to use for the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$MasterUserPassword": "The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".
Constraints:
Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$OptionGroupName": "A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
", - "ModifyDBClusterMessage$PreferredBackupWindow": "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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each 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.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$EngineVersion": "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
", - "ModifyDBClusterMessage$DBInstanceParameterGroupName": "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.
Valid for: Aurora DB clusters only
", - "ModifyDBClusterMessage$Domain": "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
", - "ModifyDBClusterMessage$DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
", - "ModifyDBClusterMessage$DBClusterInstanceClass": "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
", - "ModifyDBClusterMessage$StorageType": "Specifies the storage type to be associated with the DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBClusterMessage$MonitoringRoleArn": "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
", - "ModifyDBClusterMessage$PerformanceInsightsKMSKeyId": "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
", - "ModifyDBClusterMessage$NetworkType": "The network type of the DB cluster.
Valid values:
IPV4
DUAL
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: Aurora DB clusters only
", - "ModifyDBClusterMessage$MasterUserSecretKmsKeyId": "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
", - "ModifyDBClusterMessage$EngineMode": "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
", + "ModifyDBClusterMessage$DBClusterIdentifier": "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.
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
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
", + "ModifyDBClusterMessage$MasterUserPassword": "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.
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
", + "ModifyDBClusterMessage$PreferredBackupWindow": "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.
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.
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
", + "ModifyDBClusterMessage$DBInstanceParameterGroupName": "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.
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
", + "ModifyDBClusterMessage$DomainIAMRoleName": "The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
", + "ModifyDBClusterMessage$DBClusterInstanceClass": "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
", + "ModifyDBClusterMessage$StorageType": "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
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
", + "ModifyDBClusterMessage$PerformanceInsightsKMSKeyId": "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
", + "ModifyDBClusterMessage$NetworkType": "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
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
", + "ModifyDBClusterMessage$EngineMode": "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
", "ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName": "The name of the DB cluster parameter group to modify.
", "ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier": "The identifier for the DB cluster snapshot to modify the attributes for.
", "ModifyDBClusterSnapshotAttributeMessage$AttributeName": "The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
The new compute and memory capacity of the DB instance, for example db.m4.large. 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 or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.
Default: Uses existing setting
", - "ModifyDBInstanceMessage$DBSubnetGroupName": "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: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
Constraints: Can't be specified if ManageMasterUserPassword is turned on.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon RDS API 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.
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: The DB parameter group must be in the same DB parameter group family as the DB instance.
", - "ModifyDBInstanceMessage$PreferredBackupWindow": "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.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
Must be in the format hh24:mi-hh24:mi
Must be in Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
", - "ModifyDBInstanceMessage$EngineVersion": "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 will update 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 later 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.
The license model for the DB instance.
This setting doesn't apply to RDS Custom.
Valid values: license-included | bring-your-own-license | general-public-license
A value that indicates the DB instance should be associated with the specified option group.
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.
", - "ModifyDBInstanceMessage$NewDBInstanceIdentifier": "The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom.
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
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid values: gp2 | gp3 | io1 | standard
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
", - "ModifyDBInstanceMessage$TdeCredentialPassword": "The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
", - "ModifyDBInstanceMessage$CACertificateIdentifier": "Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
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.
", - "ModifyDBInstanceMessage$Domain": "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.
", - "ModifyDBInstanceMessage$MonitoringRoleArn": "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.
", - "ModifyDBInstanceMessage$DomainIAMRoleName": "The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
", - "ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId": "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 do not 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.
", - "ModifyDBInstanceMessage$NetworkType": "The network type of the DB instance.
Valid values:
IPV4
DUAL
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.
", + "ModifyDBInstanceMessage$DBInstanceIdentifier": "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.
The new compute and memory capacity of the DB instance, for example db.m4.large. 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 or Aurora DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and DB instance class support for RDS Custom for SQL Server.
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless you specify ApplyImmediately in your request.
Default: Uses existing setting
", + "ModifyDBInstanceMessage$DBSubnetGroupName": "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
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.
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.
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.
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.
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.
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
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.
", + "ModifyDBInstanceMessage$NewDBInstanceIdentifier": "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
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.
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.
", + "ModifyDBInstanceMessage$TdeCredentialPassword": "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.
", + "ModifyDBInstanceMessage$CACertificateIdentifier": "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.
", + "ModifyDBInstanceMessage$Domain": "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.
", + "ModifyDBInstanceMessage$MonitoringRoleArn": "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.
", + "ModifyDBInstanceMessage$DomainIAMRoleName": "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.
", + "ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId": "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.
", + "ModifyDBInstanceMessage$NetworkType": "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
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 instance doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB instance already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key 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.
", "ModifyDBInstanceMessage$Engine": "The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB to an Oracle Database 21c CDB.
Note the following requirements:
Make sure that you specify oracle-ee-cdb or oracle-se2-cdb.
Make sure that your DB engine runs Oracle Database 19c with an April 2021 or later RU.
Note the following limitations:
You can't convert a CDB to a non-CDB.
You can't convert a replica database.
You can't convert a non-CDB to a CDB and upgrade the engine version in the same command.
You can't convert the existing custom parameter or option group when it has options or parameters that are permanent or persistent. In this situation, the DB instance reverts to the default option and parameter group. To avoid reverting to the default, specify a new parameter group with --db-parameter-group-name and a new option group with --option-group-name.
The name of the DB parameter group.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
The identifier for the DB snapshot to modify the attributes for.
", "ModifyDBSnapshotAttributeMessage$AttributeName": "The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.
To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
The identifier of the DB snapshot to modify.
", - "ModifyDBSnapshotMessage$EngineVersion": "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.
", + "ModifyDBSnapshotMessage$EngineVersion": "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.
", "ModifyDBSnapshotMessage$OptionGroupName": "The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
", "ModifyDBSubnetGroupMessage$DBSubnetGroupName": "The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The description for the DB subnet group.
", @@ -4894,7 +4894,7 @@ "CreateDBProxyEndpointRequest$VpcSecurityGroupIds": "The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
", "CreateDBProxyRequest$VpcSubnetIds": "One or more VPC subnet IDs to associate with the new proxy.
", "CreateDBProxyRequest$VpcSecurityGroupIds": "One or more VPC security group IDs to associate with the new proxy.
", - "DBCluster$CustomEndpoints": "Identifies all custom endpoints associated with the cluster.
", + "DBCluster$CustomEndpoints": "The custom endpoints associated with the DB cluster.
", "DBClusterEndpoint$StaticMembers": "List of DB instance identifiers that are part of the custom endpoint group.
", "DBClusterEndpoint$ExcludedMembers": "List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
", "DBProxy$VpcSecurityGroupIds": "Provides a list of VPC security groups that the proxy belongs to.
", @@ -5023,8 +5023,8 @@ "CertificateDetails$ValidTill": "The expiration date of the DB instance’s server certificate.
", "DBCluster$AutomaticRestartTime": "The time when a stopped DB cluster is restarted automatically.
", "DBCluster$EarliestRestorableTime": "The earliest time to which a database can be restored with point-in-time restore.
", - "DBCluster$LatestRestorableTime": "Specifies the latest time to which a database can be restored with point-in-time restore.
", - "DBCluster$ClusterCreateTime": "Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
", + "DBCluster$LatestRestorableTime": "The latest time to which a database can be restored with point-in-time restore.
", + "DBCluster$ClusterCreateTime": "The time when the DB cluster was created, in Universal Coordinated Time (UTC).
", "DBCluster$EarliestBacktrackTime": "The earliest time to which a DB cluster can be backtracked.
", "DBCluster$IOOptimizedNextAllowedModificationTime": "The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.
", "DBClusterBacktrack$BacktrackTo": "The timestamp of the time to which the DB cluster was backtracked.
", @@ -5034,8 +5034,8 @@ "DBClusterSnapshot$ClusterCreateTime": "Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
", "DBEngineVersion$CreateTime": "The creation time of the DB engine version.
", "DBInstance$AutomaticRestartTime": "The time when a stopped DB instance is restarted automatically.
", - "DBInstance$InstanceCreateTime": "Provides the date and time the DB instance was created.
", - "DBInstance$LatestRestorableTime": "Specifies the latest time to which a database can be restored with point-in-time restore.
", + "DBInstance$InstanceCreateTime": "The date and time when the DB instance was created.
", + "DBInstance$LatestRestorableTime": "The latest time to which a database in this DB instance can be restored with point-in-time restore.
", "DBInstance$ResumeFullAutomationModeTime": "The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
", "DBInstanceAutomatedBackup$InstanceCreateTime": "Provides the date and time that the DB instance was created.
", "DBProxy$CreatedDate": "The date and time when the proxy was first created.
", @@ -5084,7 +5084,7 @@ "CreateBlueGreenDeploymentRequest$Tags": "Tags to assign to the blue/green deployment.
", "CreateCustomDBEngineVersionMessage$Tags": null, "CreateDBClusterEndpointMessage$Tags": "The tags to be assigned to the Amazon RDS resource.
", - "CreateDBClusterMessage$Tags": "Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "CreateDBClusterMessage$Tags": "Tags to assign to the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "CreateDBClusterParameterGroupMessage$Tags": "Tags to assign to the DB cluster parameter group.
", "CreateDBClusterSnapshotMessage$Tags": "The tags to be assigned to the DB cluster snapshot.
", "CreateDBInstanceMessage$Tags": "Tags to assign to the DB instance.
", @@ -5242,11 +5242,11 @@ "VpcSecurityGroupIdList": { "base": null, "refs": { - "CreateDBClusterMessage$VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "CreateDBInstanceMessage$VpcSecurityGroupIds": "A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
", + "CreateDBClusterMessage$VpcSecurityGroupIds": "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
", + "CreateDBInstanceMessage$VpcSecurityGroupIds": "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.
", "CreateDBInstanceReadReplicaMessage$VpcSecurityGroupIds": "A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn't apply to RDS Custom.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
", - "ModifyDBClusterMessage$VpcSecurityGroupIds": "A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", - "ModifyDBInstanceMessage$VpcSecurityGroupIds": "A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
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
", + "ModifyDBInstanceMessage$VpcSecurityGroupIds": "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.
A list of VpcSecurityGroupMembership name strings used for this option.
", "RestoreDBClusterFromS3Message$VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with the restored DB cluster.
", "RestoreDBClusterFromSnapshotMessage$VpcSecurityGroupIds": "A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", @@ -5265,15 +5265,15 @@ "VpcSecurityGroupMembershipList": { "base": null, "refs": { - "DBCluster$VpcSecurityGroups": "Provides a list of VPC security groups that the DB cluster belongs to.
", - "DBInstance$VpcSecurityGroups": "Provides a list of VPC security group elements that the DB instance belongs to.
", + "DBCluster$VpcSecurityGroups": "The list of VPC security groups that the DB cluster belongs to.
", + "DBInstance$VpcSecurityGroups": "The list of Amazon EC2 VPC security groups that the DB instance belongs to.
", "Option$VpcSecurityGroupMemberships": "If the option requires access to a port, then this VPC security group allows access to the port.
" } }, "WriteForwardingStatus": { "base": null, "refs": { - "DBCluster$GlobalWriteForwardingStatus": "Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
", + "DBCluster$GlobalWriteForwardingStatus": "The status of write forwarding for a secondary cluster in an Aurora global database.
", "GlobalClusterMember$GlobalWriteForwardingStatus": "Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
" } } diff --git a/models/apis/verifiedpermissions/2021-12-01/docs-2.json b/models/apis/verifiedpermissions/2021-12-01/docs-2.json index fb6ea7f84ba..ce9a55484a6 100644 --- a/models/apis/verifiedpermissions/2021-12-01/docs-2.json +++ b/models/apis/verifiedpermissions/2021-12-01/docs-2.json @@ -1,10 +1,10 @@ { "version": "2.0", - "service": "Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage permissions for your application, and authorize user access based on those permissions. Using Verified Permissions, application developers can grant access based on information about the users, resources, and requested actions. You can also evaluate additional information like group membership, attributes of the resources, and session context, such as time of request and IP addresses. Verified Permissions manages these permissions by letting you create and store authorization policies for your applications, such as consumer-facing web sites and enterprise business systems.
Verified Permissions uses Cedar as the policy language to express your permission requirements. Cedar supports both role-based access control (RBAC) and attribute-based access control (ABAC) authorization models.
For more information about configuring, administering, and using Amazon Verified Permissions in your applications, see the Amazon Verified Permissions User Guide.
For more information about the Cedar policy language, see the Cedar Policy Language Guide.
When you write Cedar policies that reference principals, resources and actions, you can define the unique identifiers used for each of those elements. We strongly recommend that you follow these best practices:
Use values like universally unique identifiers (UUIDs) for all principal and resource identifiers.
For example, if user jane leaves the company, and you later let someone else use the name jane, then that new user automatically gets access to everything granted by policies that still reference User::\"jane\". Cedar can’t distinguish between the new user and the old. This applies to both principal and resource identifiers. Always use identifiers that are guaranteed unique and never reused to ensure that you don’t unintentionally grant access because of the presence of an old identifier in a policy.
Where you use a UUID for an entity, we recommend that you follow it with the // comment specifier and the ‘friendly’ name of your entity. This helps to make your policies easier to understand. For example: principal == User::\"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111\", // alice
Do not include personally identifying, confidential, or sensitive information as part of the unique identifier for your principals or resources. These identifiers are included in log entries shared in CloudTrail trails.
Several operations return structures that appear similar, but have different purposes. As new functionality is added to the product, the structure used in a parameter of one operation might need to change in a way that wouldn't make sense for the same parameter in a different operation. To help you understand the purpose of each, the following naming convention is used for the structures:
Parameters that end in Detail are used in Get operations.
Parameters that end in Item are used in List operations.
Parameters that use neither suffix are used in the mutating (create and update) operations.
Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage permissions for your application, and authorize user access based on those permissions. Using Verified Permissions, application developers can grant access based on information about the users, resources, and requested actions. You can also evaluate additional information like group membership, attributes of the resources, and session context, such as time of request and IP addresses. Verified Permissions manages these permissions by letting you create and store authorization policies for your applications, such as consumer-facing web sites and enterprise business systems.
Verified Permissions uses Cedar as the policy language to express your permission requirements. Cedar supports both role-based access control (RBAC) and attribute-based access control (ABAC) authorization models.
For more information about configuring, administering, and using Amazon Verified Permissions in your applications, see the Amazon Verified Permissions User Guide.
For more information about the Cedar policy language, see the Cedar Policy Language Guide.
When you write Cedar policies that reference principals, resources and actions, you can define the unique identifiers used for each of those elements. We strongly recommend that you follow these best practices:
Use values like universally unique identifiers (UUIDs) for all principal and resource identifiers.
For example, if user jane leaves the company, and you later let someone else use the name jane, then that new user automatically gets access to everything granted by policies that still reference User::\"jane\". Cedar can’t distinguish between the new user and the old. This applies to both principal and resource identifiers. Always use identifiers that are guaranteed unique and never reused to ensure that you don’t unintentionally grant access because of the presence of an old identifier in a policy.
Where you use a UUID for an entity, we recommend that you follow it with the // comment specifier and the ‘friendly’ name of your entity. This helps to make your policies easier to understand. For example: principal == User::\"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111\", // alice
Do not include personally identifying, confidential, or sensitive information as part of the unique identifier for your principals or resources. These identifiers are included in log entries shared in CloudTrail trails.
Several operations return structures that appear similar, but have different purposes. As new functionality is added to the product, the structure used in a parameter of one operation might need to change in a way that wouldn't make sense for the same parameter in a different operation. To help you understand the purpose of each, the following naming convention is used for the structures:
Parameter type structures that end in Detail are used in Get operations.
Parameter type structures that end in Item are used in List operations.
Parameter type structures that use neither suffix are used in the mutating (create and update) operations.
Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).
After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies.
If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
To reference a user from this identity source in your Cedar policies, use the following syntax.
IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId>
Where IdentityType is the string that you provide to the PrincipalEntityType parameter for this operation. The CognitoUserPoolId and CognitoClientId are defined by the Amazon Cognito user pool.
Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template.
To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored.
Creates a policy store. A policy store is a container for policy resources.
", + "CreatePolicyStore": "Creates a policy store. A policy store is a container for policy resources.
Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store.
Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well.
", "DeleteIdentitySource": "Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After you delete the identity source, you can no longer use tokens for identities from that identity source to represent principals in authorization queries made using IsAuthorizedWithToken. operations.
", "DeletePolicy": "Deletes the specified policy from the policy store.
This operation is idempotent; if you specify a policy that doesn't exist, the request response returns a successful HTTP 200 status code.
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an Configuration structure that is used as a parameter to the Configuration.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an Configuration structure that is used as a parameter to the Configuration.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}
Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.
This data type is used as a field in the response parameter for the IsAuthorized and IsAuthorizedWithToken operations.
", "refs": { - "IsAuthorizedInput$entities": "Specifies the list of entities and their associated attributes that Verified Permissions can examine when evaluating the policies.
", - "IsAuthorizedWithTokenInput$entities": "Specifies the list of entities and their associated attributes that Verified Permissions can examine when evaluating the policies.
" + "IsAuthorizedInput$entities": "Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"UserPoolArn\": \"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"UserPoolArn\": \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"
The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.
", "IdentitySourceItemDetails$userPoolArn": "The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.
", "UpdateCognitoUserPoolConfiguration$userPoolArn": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool associated with this identity source.
" diff --git a/models/apis/verifiedpermissions/2021-12-01/endpoint-tests-1.json b/models/apis/verifiedpermissions/2021-12-01/endpoint-tests-1.json index 18725a06d46..722b079cbf0 100644 --- a/models/apis/verifiedpermissions/2021-12-01/endpoint-tests-1.json +++ b/models/apis/verifiedpermissions/2021-12-01/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -21,9 +21,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -34,9 +34,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": true } }, { @@ -47,9 +47,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-east-1" + "Region": "us-gov-east-1", + "UseDualStack": false } }, { @@ -60,9 +60,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -73,9 +73,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -86,9 +86,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": true } }, { @@ -99,9 +99,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "cn-north-1" + "Region": "cn-north-1", + "UseDualStack": false } }, { @@ -110,9 +110,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -123,9 +123,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -134,9 +134,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": true } }, { @@ -147,9 +147,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-iso-east-1" + "Region": "us-iso-east-1", + "UseDualStack": false } }, { @@ -160,9 +160,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -173,9 +173,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -186,9 +186,9 @@ } }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": true } }, { @@ -199,9 +199,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1" + "Region": "us-east-1", + "UseDualStack": false } }, { @@ -210,9 +210,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -223,9 +223,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -234,9 +234,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": true } }, { @@ -247,9 +247,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false } }, { @@ -260,9 +260,9 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -272,9 +272,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -284,9 +284,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/service/devopsguru/api.go b/service/devopsguru/api.go index bd7ffd47a76..e52c2fee0bd 100644 --- a/service/devopsguru/api.go +++ b/service/devopsguru/api.go @@ -61,16 +61,10 @@ func (c *DevOpsGuru) AddNotificationChannelRequest(input *AddNotificationChannel // is generated. // // If you use an Amazon SNS topic in another account, you must attach a policy -// to it that grants DevOps Guru permission to it notifications. DevOps Guru -// adds the required policy on your behalf to send notifications using Amazon -// SNS in your account. DevOps Guru only supports standard SNS topics. For more -// information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). -// -// If you use an Amazon SNS topic in another account, you must attach a policy -// to it that grants DevOps Guru permission to it notifications. DevOps Guru -// adds the required policy on your behalf to send notifications using Amazon -// SNS in your account. For more information, see Permissions for cross account -// Amazon SNS topics. +// to it that grants DevOps Guru permission to send it notifications. DevOps +// Guru adds the required policy on your behalf to send notifications using +// Amazon SNS in your account. DevOps Guru only supports standard SNS topics. +// For more information, see Permissions for Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). // // If you use an Amazon SNS topic that is encrypted by an Amazon Web Services // Key Management Service customer-managed key (CMK), then you must add permissions @@ -7012,6 +7006,160 @@ func (s *InternalServerException) RequestID() string { return s.RespMetadata.RequestID } +// Information about the KMS encryption used with DevOps Guru. +type KMSServerSideEncryptionIntegration struct { + _ struct{} `type:"structure"` + + // Describes the specified KMS key. + // + // To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. + // When using an alias name, prefix it with "alias/". If you specify a predefined + // Amazon Web Services alias (an Amazon Web Services alias with no key ID), + // Amazon Web Services KMS associates the alias with an Amazon Web Services + // managed key and returns its KeyId and Arn in the response. To specify a KMS + // key in a different Amazon Web Services account, you must use the key ARN + // or alias ARN. + // + // For example: + // + // Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // + // Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // + // Alias name: alias/ExampleAlias + // + // Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + KMSKeyId *string `min:"1" type:"string"` + + // Specifies if DevOps Guru is enabled for customer managed keys. + OptInStatus *string `type:"string" enum:"OptInStatus"` + + // The type of KMS key used. Customer managed keys are the KMS keys that you + // create. Amazon Web Services owned keys are keys that are owned and managed + // by DevOps Guru. + Type *string `type:"string" enum:"ServerSideEncryptionType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KMSServerSideEncryptionIntegration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KMSServerSideEncryptionIntegration) GoString() string { + return s.String() +} + +// SetKMSKeyId sets the KMSKeyId field's value. +func (s *KMSServerSideEncryptionIntegration) SetKMSKeyId(v string) *KMSServerSideEncryptionIntegration { + s.KMSKeyId = &v + return s +} + +// SetOptInStatus sets the OptInStatus field's value. +func (s *KMSServerSideEncryptionIntegration) SetOptInStatus(v string) *KMSServerSideEncryptionIntegration { + s.OptInStatus = &v + return s +} + +// SetType sets the Type field's value. +func (s *KMSServerSideEncryptionIntegration) SetType(v string) *KMSServerSideEncryptionIntegration { + s.Type = &v + return s +} + +// Information about whether DevOps Guru is configured to encrypt server-side +// data using KMS. +type KMSServerSideEncryptionIntegrationConfig struct { + _ struct{} `type:"structure"` + + // Describes the specified KMS key. + // + // To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. + // When using an alias name, prefix it with "alias/". If you specify a predefined + // Amazon Web Services alias (an Amazon Web Services alias with no key ID), + // Amazon Web Services KMS associates the alias with an Amazon Web Services + // managed key and returns its KeyId and Arn in the response. To specify a KMS + // key in a different Amazon Web Services account, you must use the key ARN + // or alias ARN. + // + // For example: + // + // Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + // + // Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab + // + // Alias name: alias/ExampleAlias + // + // Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + KMSKeyId *string `min:"1" type:"string"` + + // Specifies if DevOps Guru is enabled for KMS integration. + OptInStatus *string `type:"string" enum:"OptInStatus"` + + // The type of KMS key used. Customer managed keys are the KMS keys that you + // create. Amazon Web Services owned keys are keys that are owned and managed + // by DevOps Guru. + Type *string `type:"string" enum:"ServerSideEncryptionType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KMSServerSideEncryptionIntegrationConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KMSServerSideEncryptionIntegrationConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *KMSServerSideEncryptionIntegrationConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "KMSServerSideEncryptionIntegrationConfig"} + if s.KMSKeyId != nil && len(*s.KMSKeyId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KMSKeyId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKMSKeyId sets the KMSKeyId field's value. +func (s *KMSServerSideEncryptionIntegrationConfig) SetKMSKeyId(v string) *KMSServerSideEncryptionIntegrationConfig { + s.KMSKeyId = &v + return s +} + +// SetOptInStatus sets the OptInStatus field's value. +func (s *KMSServerSideEncryptionIntegrationConfig) SetOptInStatus(v string) *KMSServerSideEncryptionIntegrationConfig { + s.OptInStatus = &v + return s +} + +// SetType sets the Type field's value. +func (s *KMSServerSideEncryptionIntegrationConfig) SetType(v string) *KMSServerSideEncryptionIntegrationConfig { + s.Type = &v + return s +} + // Specifies one or more service names that are used to list anomalies. type ListAnomaliesForInsightFilters struct { _ struct{} `type:"structure"` @@ -8757,16 +8905,10 @@ func (s *MonitoredResourceIdentifier) SetType(v string) *MonitoredResourceIdenti // channel is Amazon Simple Notification Service (Amazon SNS). // // If you use an Amazon SNS topic in another account, you must attach a policy -// to it that grants DevOps Guru permission to it notifications. DevOps Guru -// adds the required policy on your behalf to send notifications using Amazon -// SNS in your account. DevOps Guru only supports standard SNS topics. For more -// information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). -// -// If you use an Amazon SNS topic in another account, you must attach a policy -// to it that grants DevOps Guru permission to it notifications. DevOps Guru -// adds the required policy on your behalf to send notifications using Amazon -// SNS in your account. For more information, see Permissions for cross account -// Amazon SNS topics. +// to it that grants DevOps Guru permission to send it notifications. DevOps +// Guru adds the required policy on your behalf to send notifications using +// Amazon SNS in your account. DevOps Guru only supports standard SNS topics. +// For more information, see Permissions for Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). // // If you use an Amazon SNS topic that is encrypted by an Amazon Web Services // Key Management Service customer-managed key (CMK), then you must add permissions @@ -8828,16 +8970,10 @@ type NotificationChannelConfig struct { // notifications when insights are created. // // If you use an Amazon SNS topic in another account, you must attach a policy - // to it that grants DevOps Guru permission to it notifications. DevOps Guru - // adds the required policy on your behalf to send notifications using Amazon - // SNS in your account. DevOps Guru only supports standard SNS topics. For more - // information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). - // - // If you use an Amazon SNS topic in another account, you must attach a policy - // to it that grants DevOps Guru permission to it notifications. DevOps Guru - // adds the required policy on your behalf to send notifications using Amazon - // SNS in your account. For more information, see Permissions for cross account - // Amazon SNS topics. + // to it that grants DevOps Guru permission to send it notifications. DevOps + // Guru adds the required policy on your behalf to send notifications using + // Amazon SNS in your account. DevOps Guru only supports standard SNS topics. + // For more information, see Permissions for Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). // // If you use an Amazon SNS topic that is encrypted by an Amazon Web Services // Key Management Service customer-managed key (CMK), then you must add permissions @@ -12270,6 +12406,10 @@ func (s *ServiceInsightHealth) SetOpenReactiveInsights(v int64) *ServiceInsightH type ServiceIntegrationConfig struct { _ struct{} `type:"structure"` + // Information about whether DevOps Guru is configured to encrypt server-side + // data using KMS. + KMSServerSideEncryption *KMSServerSideEncryptionIntegration `type:"structure"` + // Information about whether DevOps Guru is configured to perform log anomaly // detection on Amazon CloudWatch log groups. LogsAnomalyDetection *LogsAnomalyDetectionIntegration `type:"structure"` @@ -12297,6 +12437,12 @@ func (s ServiceIntegrationConfig) GoString() string { return s.String() } +// SetKMSServerSideEncryption sets the KMSServerSideEncryption field's value. +func (s *ServiceIntegrationConfig) SetKMSServerSideEncryption(v *KMSServerSideEncryptionIntegration) *ServiceIntegrationConfig { + s.KMSServerSideEncryption = v + return s +} + // SetLogsAnomalyDetection sets the LogsAnomalyDetection field's value. func (s *ServiceIntegrationConfig) SetLogsAnomalyDetection(v *LogsAnomalyDetectionIntegration) *ServiceIntegrationConfig { s.LogsAnomalyDetection = v @@ -12455,16 +12601,10 @@ func (s *ServiceResourceCost) SetUnitCost(v float64) *ServiceResourceCost { // Service topic. // // If you use an Amazon SNS topic in another account, you must attach a policy -// to it that grants DevOps Guru permission to it notifications. DevOps Guru -// adds the required policy on your behalf to send notifications using Amazon -// SNS in your account. DevOps Guru only supports standard SNS topics. For more -// information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). -// -// If you use an Amazon SNS topic in another account, you must attach a policy -// to it that grants DevOps Guru permission to it notifications. DevOps Guru -// adds the required policy on your behalf to send notifications using Amazon -// SNS in your account. For more information, see Permissions for cross account -// Amazon SNS topics. +// to it that grants DevOps Guru permission to send it notifications. DevOps +// Guru adds the required policy on your behalf to send notifications using +// Amazon SNS in your account. DevOps Guru only supports standard SNS topics. +// For more information, see Permissions for Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). // // If you use an Amazon SNS topic that is encrypted by an Amazon Web Services // Key Management Service customer-managed key (CMK), then you must add permissions @@ -13378,6 +13518,10 @@ func (s UpdateResourceCollectionOutput) GoString() string { type UpdateServiceIntegrationConfig struct { _ struct{} `type:"structure"` + // Information about whether DevOps Guru is configured to encrypt server-side + // data using KMS. + KMSServerSideEncryption *KMSServerSideEncryptionIntegrationConfig `type:"structure"` + // Information about whether DevOps Guru is configured to perform log anomaly // detection on Amazon CloudWatch log groups. LogsAnomalyDetection *LogsAnomalyDetectionIntegrationConfig `type:"structure"` @@ -13406,6 +13550,27 @@ func (s UpdateServiceIntegrationConfig) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateServiceIntegrationConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateServiceIntegrationConfig"} + if s.KMSServerSideEncryption != nil { + if err := s.KMSServerSideEncryption.Validate(); err != nil { + invalidParams.AddNested("KMSServerSideEncryption", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKMSServerSideEncryption sets the KMSServerSideEncryption field's value. +func (s *UpdateServiceIntegrationConfig) SetKMSServerSideEncryption(v *KMSServerSideEncryptionIntegrationConfig) *UpdateServiceIntegrationConfig { + s.KMSServerSideEncryption = v + return s +} + // SetLogsAnomalyDetection sets the LogsAnomalyDetection field's value. func (s *UpdateServiceIntegrationConfig) SetLogsAnomalyDetection(v *LogsAnomalyDetectionIntegrationConfig) *UpdateServiceIntegrationConfig { s.LogsAnomalyDetection = v @@ -13452,6 +13617,11 @@ func (s *UpdateServiceIntegrationInput) Validate() error { if s.ServiceIntegration == nil { invalidParams.Add(request.NewErrParamRequired("ServiceIntegration")) } + if s.ServiceIntegration != nil { + if err := s.ServiceIntegration.Validate(); err != nil { + invalidParams.AddNested("ServiceIntegration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -14286,6 +14456,22 @@ func ResourceTypeFilter_Values() []string { } } +const ( + // ServerSideEncryptionTypeCustomerManagedKey is a ServerSideEncryptionType enum value + ServerSideEncryptionTypeCustomerManagedKey = "CUSTOMER_MANAGED_KEY" + + // ServerSideEncryptionTypeAwsOwnedKmsKey is a ServerSideEncryptionType enum value + ServerSideEncryptionTypeAwsOwnedKmsKey = "AWS_OWNED_KMS_KEY" +) + +// ServerSideEncryptionType_Values returns all elements of the ServerSideEncryptionType enum +func ServerSideEncryptionType_Values() []string { + return []string{ + ServerSideEncryptionTypeCustomerManagedKey, + ServerSideEncryptionTypeAwsOwnedKmsKey, + } +} + const ( // ServiceNameApiGateway is a ServiceName enum value ServiceNameApiGateway = "API_GATEWAY" diff --git a/service/fsx/api.go b/service/fsx/api.go index ecabc57b2ba..62bd6f3e4c1 100644 --- a/service/fsx/api.go +++ b/service/fsx/api.go @@ -8337,7 +8337,7 @@ type CreateFileSystemOntapConfiguration struct { // The number of days to retain automatic backups. Setting this property to // 0 disables automatic backups. You can retain automatic backups for a maximum - // of 90 days. The default is 0. + // of 90 days. The default is 30. AutomaticBackupRetentionDays *int64 `type:"integer"` // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of @@ -8528,7 +8528,7 @@ type CreateFileSystemOpenZFSConfiguration struct { // The number of days to retain automatic backups. Setting this property to // 0 disables automatic backups. You can retain automatic backups for a maximum - // of 90 days. The default is 0. + // of 90 days. The default is 30. AutomaticBackupRetentionDays *int64 `type:"integer"` // A Boolean value indicating whether tags for the file system should be copied @@ -8559,10 +8559,10 @@ type CreateFileSystemOpenZFSConfiguration struct { // // * SINGLE_AZ_1- (Default) Creates file systems with throughput capacities // of 64 - 4,096 MBps. Single_AZ_1 is available in all Amazon Web Services - // Regions where Amazon FSx for OpenZFS is available, except US West (Oregon). + // Regions where Amazon FSx for OpenZFS is available. // // * SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - // - 10,240 MBps using an NVMe L2ARC cache. Single_AZ_2 is available only + // - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only // in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe // (Ireland) Amazon Web Services Regions. // @@ -8792,9 +8792,9 @@ type CreateFileSystemWindowsConfiguration struct { // Windows File Server file system. AuditLogConfiguration *WindowsAuditLogCreateConfiguration `type:"structure"` - // The number of days to retain automatic backups. The default is to retain - // backups for 7 days. Setting this value to 0 disables the creation of automatic - // backups. The maximum retention period for backups is 90 days. + // The number of days to retain automatic backups. Setting this property to + // 0 disables automatic backups. You can retain automatic backups for a maximum + // of 90 days. The default is 30. AutomaticBackupRetentionDays *int64 `type:"integer"` // A boolean flag indicating whether tags for the file system should be copied @@ -16081,7 +16081,7 @@ type LustreFileSystemConfiguration struct { // The number of days to retain automatic backups. Setting this property to // 0 disables automatic backups. You can retain automatic backups for a maximum - // of 90 days. The default is 0. + // of 90 days. The default is 30. AutomaticBackupRetentionDays *int64 `type:"integer"` // A boolean flag indicating whether tags on the file system are copied to backups. @@ -16831,7 +16831,7 @@ type OntapFileSystemConfiguration struct { // The number of days to retain automatic backups. Setting this property to // 0 disables automatic backups. You can retain automatic backups for a maximum - // of 90 days. The default is 0. + // of 90 days. The default is 30. AutomaticBackupRetentionDays *int64 `type:"integer"` // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of @@ -17394,7 +17394,7 @@ type OpenZFSFileSystemConfiguration struct { // The number of days to retain automatic backups. Setting this property to // 0 disables automatic backups. You can retain automatic backups for a maximum - // of 90 days. The default is 0. + // of 90 days. The default is 30. AutomaticBackupRetentionDays *int64 `type:"integer"` // A Boolean value indicating whether tags on the file system should be copied @@ -20493,7 +20493,7 @@ type UpdateFileSystemOntapConfiguration struct { // The number of days to retain automatic backups. Setting this property to // 0 disables automatic backups. You can retain automatic backups for a maximum - // of 90 days. The default is 0. + // of 90 days. The default is 30. AutomaticBackupRetentionDays *int64 `type:"integer"` // A recurring daily time, in the format HH:MM. HH is the zero-padded hour of @@ -20639,7 +20639,7 @@ type UpdateFileSystemOpenZFSConfiguration struct { // The number of days to retain automatic backups. Setting this property to // 0 disables automatic backups. You can retain automatic backups for a maximum - // of 90 days. The default is 0. + // of 90 days. The default is 30. AutomaticBackupRetentionDays *int64 `type:"integer"` // A Boolean value indicating whether tags for the file system should be copied @@ -20818,9 +20818,9 @@ type UpdateFileSystemWindowsConfiguration struct { // Windows File Server file system.. AuditLogConfiguration *WindowsAuditLogCreateConfiguration `type:"structure"` - // The number of days to retain automatic daily backups. Setting this to zero - // (0) disables automatic daily backups. You can retain automatic daily backups - // for a maximum of 90 days. For more information, see Working with Automatic + // The number of days to retain automatic backups. Setting this property to + // 0 disables automatic backups. You can retain automatic backups for a maximum + // of 90 days. The default is 30. For more information, see Working with Automatic // Daily Backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups). AutomaticBackupRetentionDays *int64 `type:"integer"` diff --git a/service/rds/api.go b/service/rds/api.go index adb94f14ca0..4331fbdbf4b 100644 --- a/service/rds/api.go +++ b/service/rds/api.go @@ -6002,8 +6002,8 @@ func (c *RDS) DescribeDBClustersRequest(input *DescribeDBClustersInput) (req *re // DescribeDBClusters API operation for Amazon Relational Database Service. // -// Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. -// This API supports pagination. +// 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? // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) @@ -6420,7 +6420,7 @@ func (c *RDS) DescribeDBInstancesRequest(input *DescribeDBInstancesInput) (req * // DescribeDBInstances API operation for Amazon Relational Database Service. // -// Returns information about provisioned RDS instances. This API supports pagination. +// Describes provisioned RDS instances. This API supports pagination. // // This operation can also return information for Amazon Neptune DB instances // and Amazon DocumentDB instances. @@ -10766,7 +10766,7 @@ func (c *RDS) ModifyDBClusterRequest(input *ModifyDBClusterInput) (req *request. // ModifyDBCluster API operation for Amazon Relational Database Service. // -// Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. +// 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. // @@ -19568,16 +19568,16 @@ type CreateDBClusterInput struct { // 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. + // Valid for Cluster Type: Multi-AZ DB clusters only // - // Valid for: Multi-AZ DB clusters only + // This setting is required to create a Multi-AZ DB cluster. AllocatedStorage *int64 `type:"integer"` - // A value that indicates whether minor engine upgrades are applied automatically - // to the DB cluster during the maintenance window. By default, minor engine - // upgrades are applied automatically. + // 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: Multi-AZ DB clusters only + // Valid for Cluster Type: Multi-AZ DB clusters only AutoMinorVersionUpgrade *bool `type:"boolean"` // A list of Availability Zones (AZs) where DB instances in the DB cluster can @@ -19587,46 +19587,49 @@ type CreateDBClusterInput struct { // Choosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"` // 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). - // - // Valid for: Aurora MySQL DB clusters only BacktrackWindow *int64 `type:"long"` // 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 - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * Must be a value from 1 to 35. BackupRetentionPeriod *int64 `type:"integer"` - // A value that indicates that the DB cluster should be associated with the - // specified CharacterSet. + // The name of the character set (CharacterSet) to associate the DB cluster + // with. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only CharacterSetName *string `type:"string"` - // A value that indicates whether to copy all tags from the DB cluster to snapshots - // of the DB cluster. The default is not to copy them. + // 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: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters CopyTagsToSnapshot *bool `type:"boolean"` - // The DB cluster identifier. This parameter is stored as a lowercase string. + // 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: // @@ -19638,8 +19641,6 @@ type CreateDBClusterInput struct { // // Example: my-cluster1 // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters - // // DBClusterIdentifier is a required field DBClusterIdentifier *string `type:"string" required:"true"` @@ -19653,48 +19654,51 @@ type CreateDBClusterInput struct { // // This setting is required to create a Multi-AZ DB cluster. // - // Valid for: Multi-AZ DB clusters only + // Valid for Cluster Type: Multi-AZ DB clusters only DBClusterInstanceClass *string `type:"string"` // The name of the DB cluster parameter group to associate with this DB cluster. - // If you do not specify a value, then the default DB cluster parameter group + // 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. - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters DBClusterParameterGroupName *string `type:"string"` // A DB subnet group to associate with this DB cluster. // // This setting is required to create a Multi-AZ DB cluster. // - // Constraints: Must match the name of an existing DBSubnetGroup. Must not be - // default. + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // - // Example: mydbsubnetgroup + // Constraints: // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * Must match the name of an existing DB subnet group. + // + // * Must not be default. + // + // Example: mydbsubnetgroup DBSubnetGroupName *string `type:"string"` // Reserved for future use. DBSystemId *string `type:"string"` - // The name for your database of up to 64 alphanumeric characters. If you do - // not provide a name, Amazon RDS doesn't create a database in the DB cluster - // you are creating. + // 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: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DatabaseName *string `type:"string"` - // A value that indicates whether the DB cluster has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. + // 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: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool `type:"boolean"` // DestinationRegion is used for presigning the request to a given region. @@ -19708,33 +19712,28 @@ type CreateDBClusterInput struct { // For more information, see Kerberos authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only Domain *string `type:"string"` - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. + // The name of the IAM role to use when making API calls to the Directory Service. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only DomainIAMRoleName *string `type:"string"` // The list of log types that need to be enabled for exporting to CloudWatch - // Logs. The values in the list depend on the DB engine being used. + // Logs. // - // RDS for MySQL + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // - // Possible values are error, general, and slowquery. + // The following values are valid for each DB engine: // - // RDS for PostgreSQL + // * Aurora MySQL - audit | error | general | slowquery // - // Possible values are postgresql and upgrade. + // * Aurora PostgreSQL - postgresql // - // Aurora MySQL - // - // Possible values are audit, error, general, and slowquery. + // * RDS for MySQL - error | general | slowquery // - // Aurora PostgreSQL - // - // Possible value is postgresql. + // * RDS for PostgreSQL - postgresql | upgrade // // For more information about exporting CloudWatch Logs for Amazon RDS, see // Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) @@ -19743,27 +19742,25 @@ type CreateDBClusterInput struct { // For more information about exporting CloudWatch Logs for Amazon Aurora, see // Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon Aurora User Guide. - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters EnableCloudwatchLogsExports []*string `type:"list"` - // A value that indicates whether to enable this DB cluster to forward write - // operations to the primary cluster of an Aurora global database (GlobalCluster). - // By default, write operations are not allowed on Aurora DB clusters that are - // secondary clusters in an Aurora global database. + // 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 + // 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 the FailoverGlobalCluster API operation, but it does nothing until then. + // by a global cluster API operation, but it does nothing until then. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only EnableGlobalWriteForwarding *bool `type:"boolean"` - // A value that indicates whether to enable the HTTP endpoint for an Aurora - // Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. + // 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 @@ -19772,41 +19769,32 @@ type CreateDBClusterInput struct { // For more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only EnableHttpEndpoint *bool `type:"boolean"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to turn on Performance Insights for the DB - // cluster. + // Specifies whether to turn on Performance Insights for the DB cluster. // // For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. // - // Valid for: Multi-AZ DB clusters only + // Valid for Cluster Type: Multi-AZ DB clusters only EnablePerformanceInsights *bool `type:"boolean"` - // The name of the database engine to be used for this DB cluster. - // - // Valid Values: - // - // * aurora-mysql - // - // * aurora-postgresql - // - // * mysql + // The database engine to use for this DB cluster. // - // * postgres + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres // // Engine is a required field Engine *string `type:"string" required:"true"` @@ -19822,7 +19810,7 @@ type CreateDBClusterInput struct { // // * Requirements for Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html) // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only EngineMode *string `type:"string"` // The version number of the database engine to use. @@ -19850,34 +19838,28 @@ type CreateDBClusterInput struct { // // aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" // - // Aurora MySQL - // - // For information, see Database engine updates for Amazon Aurora MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) - // in the Amazon Aurora User Guide. + // For information about a specific engine, see the following topics: // - // Aurora PostgreSQL - // - // For information, see Amazon Aurora PostgreSQL releases and engine versions - // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) - // in the Amazon Aurora User Guide. - // - // MySQL + // * Aurora MySQL - see Database engine updates for Amazon Aurora MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) + // in the Amazon Aurora User Guide. // - // For information, see Amazon RDS for MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) - // in the Amazon RDS User Guide. + // * Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine + // versions (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) + // in the Amazon Aurora User Guide. // - // PostgreSQL + // * RDS for MySQL - see Amazon RDS for MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) + // in the Amazon RDS User Guide. // - // For information, see Amazon RDS for PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) - // in the Amazon RDS User Guide. + // * RDS for PostgreSQL - see Amazon RDS for PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) + // in the Amazon RDS User Guide. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters EngineVersion *string `type:"string"` // 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 + // Valid for Cluster Type: Aurora DB clusters only GlobalClusterIdentifier *string `type:"string"` // The amount of Provisioned IOPS (input/output operations per second) to be @@ -19888,10 +19870,12 @@ type CreateDBClusterInput struct { // // This setting is required to create a Multi-AZ DB cluster. // - // Constraints: Must be a multiple between .5 and 50 of the storage amount for - // the DB cluster. + // Valid for Cluster Type: Multi-AZ DB clusters only // - // Valid for: Multi-AZ DB clusters only + // Constraints: + // + // * Must be a multiple between .5 and 50 of the storage amount for the DB + // cluster. Iops *int64 `type:"integer"` // The Amazon Web Services KMS key identifier for an encrypted DB cluster. @@ -19903,26 +19887,26 @@ type CreateDBClusterInput struct { // When a KMS key isn't specified in KmsKeyId: // // * If ReplicationSourceIdentifier identifies an encrypted source, then - // Amazon RDS will use the KMS key used to encrypt the source. Otherwise, - // Amazon RDS will use your default KMS key. + // 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 will use your default KMS key. + // 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, you must set KmsKeyId to a KMS key identifier that is - // valid in the destination Amazon Web Services Region. This KMS key is used + // 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: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters KmsKeyId *string `type:"string"` - // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) @@ -19930,24 +19914,25 @@ type CreateDBClusterInput struct { // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // 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. - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters ManageMasterUserPassword *bool `type:"boolean"` - // The password for the master database user. This password can contain any - // printable ASCII character except "/", """, or "@". + // 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't be specified if ManageMasterUserPassword is turned on. + // * Can contain any printable ASCII character except "/", """, or "@". // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * Can't be specified if ManageMasterUserPassword is turned on. MasterUserPassword *string `type:"string"` // The Amazon Web Services KMS key identifier to encrypt a secret that is automatically @@ -19969,11 +19954,13 @@ type CreateDBClusterInput struct { // 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 + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *string `type:"string"` // 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. @@ -19981,20 +19968,20 @@ type CreateDBClusterInput struct { // * First character must be a letter. // // * Can't be a reserved word for the chosen database engine. - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters MasterUsername *string `type:"string"` // 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. The default is 0. + // metrics, specify 0. // // If MonitoringRoleArn is specified, also set MonitoringInterval to a value // other than 0. // - // Valid Values: 0, 1, 5, 10, 15, 30, 60 + // Valid for Cluster Type: Multi-AZ DB clusters only // - // Valid for: Multi-AZ DB clusters only + // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 + // + // Default: 0 MonitoringInterval *int64 `type:"integer"` // The Amazon Resource Name (ARN) for the IAM role that permits RDS to send @@ -20006,17 +19993,11 @@ type CreateDBClusterInput struct { // If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn // value. // - // Valid for: Multi-AZ DB clusters only + // Valid for Cluster Type: Multi-AZ DB clusters only MonitoringRoleArn *string `type:"string"` // The network type of the DB cluster. // - // Valid values: - // - // * IPV4 - // - // * DUAL - // // 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). @@ -20024,11 +20005,12 @@ type CreateDBClusterInput struct { // For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only + // + // Valid Values: IPV4 | DUAL NetworkType *string `type:"string"` - // A value that indicates that the DB cluster should be associated with the - // specified option group. + // The option group to associate the DB cluster with. // // DB clusters are associated with a default option group that can't be modified. OptionGroupName *string `type:"string"` @@ -20044,49 +20026,39 @@ type CreateDBClusterInput struct { // 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 + // Valid for Cluster Type: Multi-AZ DB clusters only PerformanceInsightsKMSKeyId *string `type:"string"` - // The number of days to retain Performance Insights data. The default is 7 - // days. The following values are valid: - // - // * 7 + // The number of days to retain Performance Insights data. // - // * month * 31, where month is a number of months from 1-23 + // Valid for Cluster Type: Multi-AZ DB clusters only // - // * 731 - // - // For example, the following values are valid: - // - // * 93 (3 months * 31) + // Valid Values: // - // * 341 (11 months * 31) + // * 7 // - // * 589 (19 months * 31) + // * 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 // - // If you specify a retention period such as 94, which isn't a valid value, - // RDS issues an error. + // Default: 7 days // - // Valid for: Multi-AZ DB clusters only + // If you specify a retention period that isn't valid, such as 94, Amazon RDS + // issues an error. PerformanceInsightsRetentionPeriod *int64 `type:"integer"` // The port number on which the instances in the DB cluster accept connections. // - // RDS for MySQL and Aurora MySQL + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // - // Default: 3306 - // - // Valid values: 1150-65535 - // - // RDS for PostgreSQL and Aurora PostgreSQL + // Valid Values: 1150-65535 // - // Default: 5432 + // Default: // - // Valid values: 1150-65535 + // * RDS for MySQL and Aurora MySQL - 3306 // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * RDS for PostgreSQL and Aurora PostgreSQL - 5432 Port *int64 `type:"integer"` // When you are replicating a DB cluster from one Amazon Web Services GovCloud @@ -20129,12 +20101,14 @@ type CreateDBClusterInput struct { // valid request for the operation that can run in the source Amazon Web Services // Region. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only PreSignedUrl *string `type:"string"` // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) @@ -20149,14 +20123,11 @@ type CreateDBClusterInput struct { // * Must not conflict with the preferred maintenance window. // // * Must be at least 30 minutes. - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters PreferredBackupWindow *string `type:"string"` - // The weekly time range during which system maintenance can occur, in Universal - // Coordinated Time (UTC). + // The weekly time range during which system maintenance can occur. // - // Format: ddd:hh24:mi-ddd:hh24:mi + // 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 @@ -20164,14 +20135,18 @@ type CreateDBClusterInput struct { // Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) // in the Amazon Aurora User Guide. // - // Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // Constraints: // - // Constraints: Minimum 30-minute window. + // * Must be in the format ddd:hh24:mi-ddd:hh24:mi. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * 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. PreferredMaintenanceWindow *string `type:"string"` - // A value that indicates whether the DB cluster is publicly accessible. + // 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 @@ -20183,6 +20158,8 @@ type CreateDBClusterInput struct { // 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. // @@ -20203,20 +20180,18 @@ type CreateDBClusterInput struct { // // * If the subnets are part of a VPC that has an internet gateway attached // to it, the DB cluster is public. - // - // Valid for: Multi-AZ DB clusters only PubliclyAccessible *bool `type:"boolean"` // 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 + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters ReplicationSourceIdentifier *string `type:"string"` // For DB clusters in serverless DB engine mode, the scaling properties of the // DB cluster. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only ScalingConfiguration *ScalingConfiguration `type:"structure"` // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. @@ -20230,39 +20205,46 @@ type CreateDBClusterInput struct { // have the same region as the source ARN. SourceRegion *string `type:"string" ignore:"true"` - // A value that indicates whether the DB cluster is encrypted. + // Specifies whether the DB cluster is encrypted. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters StorageEncrypted *bool `type:"boolean"` - // Specifies the storage type to be associated with the DB cluster. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). + // For information on storage types for Multi-AZ DB clusters, see Settings for + // creating Multi-AZ DB clusters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings). // // 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 values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB - // clusters) + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // - // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) + // Valid Values: // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * Aurora DB clusters - aurora | aurora-iopt1 + // + // * Multi-AZ DB clusters - io1 + // + // Default: + // + // * Aurora DB clusters - aurora // - // For more information on storage types for Aurora DB clusters, see Storage - // configurations for Amazon Aurora DB clusters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). - // For more information on storage types for Multi-AZ DB clusters, see Settings - // for creating Multi-AZ DB clusters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings). + // * Multi-AZ DB clusters - io1 StorageType *string `type:"string"` // Tags to assign to the DB cluster. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Tags []*Tag `locationNameList:"Tag" type:"list"` // A list of EC2 VPC security groups to associate with this DB cluster. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` } @@ -20946,15 +20928,22 @@ type CreateDBInstanceInput struct { // The amount of storage in gibibytes (GiB) to allocate for the DB instance. // - // Type: Integer + // 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 Aurora + // Amazon RDS Custom // - // Not applicable. Aurora cluster volumes automatically grow as the amount of - // data in your database increases, though you are only charged for the space - // that you use in an Aurora cluster volume. + // RDS for MariaDB // - // Amazon RDS Custom + // 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: // @@ -20964,8 +20953,6 @@ type CreateDBInstanceInput struct { // * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 // for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. // - // MySQL - // // 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 @@ -20975,8 +20962,6 @@ type CreateDBInstanceInput struct { // // * Magnetic storage (standard): Must be an integer from 5 to 3072. // - // MariaDB - // // Constraints to the amount of storage for each storage type are the following: // // * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 @@ -20986,8 +20971,6 @@ type CreateDBInstanceInput struct { // // * Magnetic storage (standard): Must be an integer from 5 to 3072. // - // PostgreSQL - // // Constraints to the amount of storage for each storage type are the following: // // * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 @@ -20995,9 +20978,7 @@ type CreateDBInstanceInput struct { // // * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. // - // * Magnetic storage (standard): Must be an integer from 5 to 3072. - // - // Oracle + // * Magnetic storage (standard): Must be an integer from 10 to 3072. // // Constraints to the amount of storage for each storage type are the following: // @@ -21006,9 +20987,7 @@ type CreateDBInstanceInput struct { // // * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. // - // * Magnetic storage (standard): Must be an integer from 10 to 3072. - // - // SQL Server + // * Magnetic storage (standard): Must be an integer from 5 to 3072. // // Constraints to the amount of storage for each storage type are the following: // @@ -21025,9 +21004,9 @@ type CreateDBInstanceInput struct { // from 20 to 1024. AllocatedStorage *int64 `type:"integer"` - // A value that indicates whether minor engine upgrades are applied automatically - // to the DB instance during the maintenance window. By default, minor engine - // upgrades are applied automatically. + // 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. @@ -21037,56 +21016,61 @@ type CreateDBInstanceInput struct { // on Amazon Web Services Regions and Availability Zones, see Regions and Availability // Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). // - // 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. + // 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. // - // Example: us-east-1d + // Constraints: // - // Constraint: The AvailabilityZone parameter can't be specified if the DB instance - // is a Multi-AZ deployment. The specified Availability Zone must be in the - // same Amazon Web Services Region as the current endpoint. + // * 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 AvailabilityZone *string `type:"string"` // The number of days for which automated backups are retained. Setting this // parameter to a positive number enables backups. Setting this parameter to // 0 disables automated backups. // - // Amazon Aurora - // - // Not applicable. The retention period for automated backups is managed by - // the DB cluster. + // 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 + // * 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 if the DB instance is a source to read replicas. // - // * Can't be set to 0 for an RDS Custom for Oracle DB instance + // * Can't be set to 0 for an RDS Custom for Oracle DB instance. BackupRetentionPeriod *int64 `type:"integer"` - // Specifies where automated backups and manual snapshots are stored. + // The location for storing automated backups and manual snapshots. // - // Possible values are outposts (Amazon Web Services Outposts) and region (Amazon - // Web Services Region). The default is region. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) // in the Amazon RDS User Guide. BackupTarget *string `type:"string"` - // Specifies the CA certificate identifier to use for the DB instance’s server - // certificate. + // The CA certificate identifier to use for the DB instance's server certificate. // - // This setting doesn't apply to RDS Custom. + // 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 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) @@ -21095,29 +21079,32 @@ type CreateDBInstanceInput struct { // in the Amazon Aurora User Guide. CACertificateIdentifier *string `type:"string"` - // For supported engines, this value indicates that the DB instance should be - // associated with the specified CharacterSet. + // For supported engines, the character set (CharacterSet) to associate the + // DB instance with. // - // This setting doesn't apply to RDS Custom. However, if you need to change - // the character set, you can change it on the database itself. + // This setting doesn't apply to the following DB instances: // - // Amazon Aurora + // * Amazon Aurora - The character set is managed by the DB cluster. For + // more information, see CreateDBCluster. // - // Not applicable. 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. CharacterSetName *string `type:"string"` - // A value that indicates whether to copy tags from the DB instance to snapshots - // of the DB instance. By default, tags are not copied. - // - // Amazon Aurora + // Spcifies whether to copy tags from the DB instance to snapshots of the DB + // instance. By default, tags are not copied. // - // Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting - // this value for an Aurora DB instance has no effect on the DB cluster setting. + // 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. CopyTagsToSnapshot *bool `type:"boolean"` // The instance profile associated with the underlying Amazon EC2 instance of - // an RDS Custom DB instance. The instance profile must meet the following requirements: + // an RDS Custom DB instance. + // + // This setting is required for RDS Custom. + // + // Constraints: // // * The profile must exist in your account. // @@ -21130,13 +21117,11 @@ type CreateDBInstanceInput struct { // For the list of permissions required for the IAM role, see Configure IAM // and your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) // in the Amazon RDS User Guide. - // - // This setting is required for RDS Custom. CustomIamInstanceProfile *string `type:"string"` - // The identifier of the DB cluster that the instance will belong to. + // The identifier of the DB cluster that this DB instance will belong to. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. DBClusterIdentifier *string `type:"string"` // The compute and memory capacity of the DB instance, for example db.m5.large. @@ -21149,7 +21134,8 @@ type CreateDBInstanceInput struct { // DBInstanceClass is a required field DBInstanceClass *string `type:"string" required:"true"` - // The DB instance identifier. This parameter is stored as a lowercase string. + // The identifier for this DB instance. This parameter is stored as a lowercase + // string. // // Constraints: // @@ -21164,129 +21150,128 @@ type CreateDBInstanceInput struct { // DBInstanceIdentifier is a required field DBInstanceIdentifier *string `type:"string" required:"true"` - // The meaning of this parameter differs according to the database engine you - // use. + // The meaning of this parameter differs depending on the database engine. // - // MySQL + // Amazon Aurora MySQL // - // The name of the database to create when the DB instance is created. If this - // parameter isn't specified, no database is created in the DB instance. + // Amazon Aurora PostgreSQL // - // Constraints: + // Amazon RDS Custom for Oracle // - // * Must contain 1 to 64 letters or numbers. + // Amazon RDS Custom for SQL Server // - // * Must begin with a letter. Subsequent characters can be letters, underscores, - // or digits (0-9). + // RDS for MariaDB // - // * Can't be a word reserved by the specified database engine + // RDS for MySQL // - // MariaDB + // RDS for Oracle // - // The name of the database to create when the DB instance is created. If this - // parameter isn't specified, no database is created in the DB instance. + // RDS for PostgreSQL // - // Constraints: + // RDS for SQL Server // - // * Must contain 1 to 64 letters or numbers. + // 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. // - // * Must begin with a letter. Subsequent characters can be letters, underscores, - // or digits (0-9). + // Constraints: // - // * Can't be a word reserved by the specified database engine + // * Must contain 1 to 64 alphanumeric characters. // - // PostgreSQL + // * Can't be a word reserved by the database engine. // - // The name of the database to create when the DB instance is created. If this - // parameter isn't specified, a database named postgres is created in the DB - // instance. + // 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 letters, numbers, or underscores. + // * Must contain 1 to 63 alphanumeric characters. // // * Must begin with a letter. Subsequent characters can be letters, underscores, - // or digits (0-9). - // - // * Can't be a word reserved by the specified database engine + // or digits (0 to 9). // - // Oracle + // * Can't be a word reserved by the database engine. // - // The Oracle System ID (SID) of the created DB instance. If you specify null, - // the default value ORCL is used. You can't specify the string NULL, or any - // other reserved word, for DBName. + // The Oracle System ID (SID) of the created RDS Custom DB instance. // // Default: ORCL // // Constraints: // - // * Can't be longer than 8 characters + // * Must contain 1 to 8 alphanumeric characters. // - // Amazon RDS Custom for Oracle + // * Must contain a letter. // - // The Oracle System ID (SID) of the created RDS Custom DB instance. If you - // don't specify a value, the default value is ORCL. + // * Can't be a word reserved by the database engine. // - // Default: ORCL + // 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: // - // * It must contain 1 to 8 alphanumeric characters. + // * Must contain 1 to 64 letters or numbers. // - // * It must contain a letter. + // * Must begin with a letter. Subsequent characters can be letters, underscores, + // or digits (0-9). // - // * It can't be a word reserved by the database engine. + // * Can't be a word reserved by the database engine. // - // Amazon RDS Custom for SQL Server + // 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. // - // Not applicable. Must be null. + // Constraints: // - // SQL Server + // * Must contain 1 to 64 letters or numbers. // - // Not applicable. Must be null. + // * Must begin with a letter. Subsequent characters can be letters, underscores, + // or digits (0-9). // - // Amazon Aurora MySQL + // * 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 - // MySQL DB cluster is created. If this parameter isn't specified for an Aurora - // MySQL DB cluster, no database is created in the DB cluster. + // The Oracle System ID (SID) of the created DB instance. + // + // Default: ORCL // // Constraints: // - // * It must contain 1 to 64 alphanumeric characters. + // * Can't be longer than 8 characters. // - // * It can't be a word reserved by the database engine. + // * Can't be a word reserved by the database engine, such as the string + // NULL. // - // Amazon Aurora PostgreSQL + // The name of the database to create when the DB instance is created. // - // The name of the database to create when the primary DB instance of the Aurora - // PostgreSQL DB cluster is created. If this parameter isn't specified for an - // Aurora PostgreSQL DB cluster, a database named postgres is created in the - // DB cluster. + // Default: postgres // // Constraints: // - // * It must contain 1 to 63 alphanumeric characters. + // * Must contain 1 to 63 letters, numbers, or underscores. // - // * It must begin with a letter. Subsequent characters can be letters, underscores, - // or digits (0 to 9). + // * 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. // - // * It can't be a word reserved by the database engine. + // Not applicable. Must be null. DBName *string `type:"string"` // The name of the DB parameter group to associate with this DB instance. If - // you do not specify a value, then the default DB parameter group for the specified - // DB engine and version is used. + // 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. + // This setting doesn't apply to RDS Custom DB instances. // // Constraints: // - // * It must be 1 to 255 letters, numbers, or hyphens. + // * Must be 1 to 255 letters, numbers, or hyphens. // // * The first character must be a letter. // - // * It can't end with a hyphen or contain two consecutive hyphens. + // * Can't end with a hyphen or contain two consecutive hyphens. DBParameterGroupName *string `type:"string"` // A list of DB security groups to associate with this DB instance. @@ -21297,85 +21282,75 @@ type CreateDBInstanceInput struct { // A DB subnet group to associate with this DB instance. // - // Constraints: Must match the name of an existing DBSubnetGroup. Must not be - // default. + // Constraints: + // + // * Must match the name of an existing DB subnet group. + // + // * Must not be default. // // Example: mydbsubnetgroup DBSubnetGroupName *string `type:"string"` - // A value that indicates whether the DB instance has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. For more information, see Deleting a DB - // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // 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 + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). // - // Amazon Aurora - // - // Not applicable. You can enable or disable deletion protection for the DB - // cluster. For more information, see CreateDBCluster. DB instances in a DB - // cluster can be deleted even when deletion protection is enabled for the DB - // cluster. + // 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. DeletionProtection *bool `type:"boolean"` // The Active Directory directory ID to create the DB instance in. Currently, - // only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can + // only Microsoft SQL Server, MySQL, Oracle, and PostgreSQL DB instances can // be created in an Active Directory Domain. // // For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to the following DB instances: // - // Amazon Aurora + // * Amazon Aurora (The domain is managed by the DB cluster.) // - // Not applicable. The domain is managed by the DB cluster. + // * RDS Custom Domain *string `type:"string"` - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. + // The name of the IAM role to use when making API calls to the Directory Service. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to the following DB instances: // - // Amazon Aurora + // * Amazon Aurora (The domain is managed by the DB cluster.) // - // Not applicable. The domain is managed by the DB cluster. + // * RDS Custom DomainIAMRoleName *string `type:"string"` // The list of log types that need to be enabled for exporting to CloudWatch - // Logs. The values in the list depend on the DB engine. For more information, - // see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // Logs. For more information, see Publishing Database Logs to Amazon CloudWatch + // Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. // - // Amazon Aurora + // This setting doesn't apply to the following DB instances: // - // Not applicable. CloudWatch Logs exports are managed by the DB cluster. + // * Amazon Aurora (CloudWatch Logs exports are managed by the DB cluster.) // - // RDS Custom + // * RDS Custom // - // Not applicable. + // The following values are valid for each DB engine: // - // MariaDB + // * RDS for MariaDB - audit | error | general | slowquery // - // Possible values are audit, error, general, and slowquery. + // * RDS for Microsoft SQL Server - agent | error // - // Microsoft SQL Server + // * RDS for MySQL - audit | error | general | slowquery // - // Possible values are agent and error. + // * RDS for Oracle - alert | audit | listener | trace | oemagent // - // MySQL - // - // Possible values are audit, error, general, and slowquery. - // - // Oracle - // - // Possible values are alert, audit, listener, trace, and oemagent. - // - // PostgreSQL - // - // Possible values are postgresql and upgrade. + // * RDS for PostgreSQL - postgresql | upgrade EnableCloudwatchLogsExports []*string `type:"list"` - // A value that indicates whether to enable a customer-owned IP address (CoIP) - // for an RDS on Outposts DB instance. + // 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 @@ -21390,32 +21365,32 @@ type CreateDBInstanceInput struct { // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool `type:"boolean"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // 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 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to the following DB instances: // - // Amazon Aurora + // * Amazon Aurora (Mapping Amazon Web Services IAM accounts to database + // accounts is managed by the DB cluster.) // - // Not applicable. Mapping Amazon Web Services IAM accounts to database accounts - // is managed by the DB cluster. + // * RDS Custom EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to enable Performance Insights for the DB - // instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) + // Specifies whether to enable Performance Insights for the DB instance. For + // more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. EnablePerformanceInsights *bool `type:"boolean"` - // The name of the database engine to be used for this instance. + // The database engine to use for this DB instance. // - // Not every database engine is available for every Amazon Web Services Region. + // Not every database engine is available in every Amazon Web Services Region. // // Valid Values: // @@ -21460,18 +21435,28 @@ type CreateDBInstanceInput struct { // 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 Aurora + // Amazon RDS Custom for Oracle + // + // Amazon RDS Custom for SQL Server // - // Not applicable. The version number of the database engine to be used by the - // DB instance is managed by the DB cluster. + // RDS for MariaDB // - // Amazon RDS Custom for Oracle + // 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: @@ -21479,50 +21464,40 @@ type CreateDBInstanceInput struct { // see Creating an RDS Custom for Oracle DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create) // in the Amazon RDS User Guide. // - // Amazon RDS Custom for SQL Server - // // See RDS Custom for SQL Server general requirements (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html) // in the Amazon RDS User Guide. // - // MariaDB - // - // For information, see MariaDB on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) + // For information, see MariaDB on Amazon RDS versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) // in the Amazon RDS User Guide. // - // Microsoft SQL Server - // - // For information, see Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) + // For information, see Microsoft SQL Server versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) // in the Amazon RDS User Guide. // - // MySQL - // - // For information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) + // For information, see MySQL on Amazon RDS versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) // in the Amazon RDS User Guide. // - // Oracle - // - // For information, see Oracle Database Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) + // For information, see Oracle Database Engine release notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) // in the Amazon RDS User Guide. // - // PostgreSQL - // // For information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) // in the Amazon RDS User Guide. EngineVersion *string `type:"string"` - // The amount of Provisioned IOPS (input/output operations per second) to be - // initially allocated for the DB instance. For information about valid IOPS - // values, see Amazon RDS DB instance storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) // in the Amazon RDS User Guide. // - // Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must - // be a multiple between .5 and 50 of the storage amount for the DB instance. - // For SQL Server DB instances, must be a multiple between 1 and 50 of the storage - // amount for the DB instance. + // This setting doesn't apply to Amazon Aurora DB instances. Storage is managed + // by the DB cluster. + // + // Constraints: // - // Amazon Aurora + // * For RDS for MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple + // between .5 and 50 of the storage amount for the DB instance. // - // Not applicable. Storage is managed by the DB cluster. + // * For RDS for SQL Server - Must be a multiple between 1 and 50 of the + // storage amount for the DB instance. Iops *int64 `type:"integer"` // The Amazon Web Services KMS key identifier for an encrypted DB instance. @@ -21531,37 +21506,40 @@ type CreateDBInstanceInput struct { // 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. // - // Amazon Aurora - // - // Not applicable. The Amazon Web Services KMS key identifier is managed by - // the DB cluster. For more information, see CreateDBCluster. + // 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. // - // Amazon RDS Custom - // - // A KMS key is required for RDS Custom 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. + // 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. KmsKeyId *string `type:"string"` - // License model information for this DB instance. + // The license model information for this DB instance. // - // Valid values: license-included | bring-your-own-license | general-public-license + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. // - // This setting doesn't apply to RDS Custom. + // Valid Values: + // + // * RDS for MariaDB - general-public-license + // + // * RDS for Microsoft SQL Server - license-included // - // Amazon Aurora + // * RDS for MySQL - general-public-license // - // Not applicable. + // * RDS for Oracle - bring-your-own-license | license-included + // + // * RDS for PostgreSQL - postgresql-license LicenseModel *string `type:"string"` - // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) @@ -21573,34 +21551,28 @@ type CreateDBInstanceInput struct { // Manager if MasterUserPassword is specified. ManageMasterUserPassword *bool `type:"boolean"` - // The password for the master user. The password can include any printable - // ASCII character except "/", """, or "@". - // - // Amazon Aurora + // The password for the master user. // - // Not applicable. The password for the master user is managed by the DB cluster. + // 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. - // - // MariaDB - // - // Constraints: Must contain from 8 to 41 characters. + // Constraints: // - // Microsoft SQL Server + // * Can't be specified if ManageMasterUserPassword is turned on. // - // Constraints: Must contain from 8 to 128 characters. + // * Can include any printable ASCII character except "/", """, or "@". // - // MySQL + // Length Constraints: // - // Constraints: Must contain from 8 to 41 characters. + // * RDS for MariaDB - Must contain from 8 to 41 characters. // - // Oracle + // * RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. // - // Constraints: Must contain from 8 to 30 characters. + // * RDS for MySQL - Must contain from 8 to 41 characters. // - // PostgreSQL + // * RDS for Oracle - Must contain from 8 to 30 characters. // - // Constraints: Must contain from 8 to 128 characters. + // * RDS for PostgreSQL - Must contain from 8 to 128 characters. MasterUserPassword *string `type:"string"` // The Amazon Web Services KMS key identifier to encrypt a secret that is automatically @@ -21625,16 +21597,13 @@ type CreateDBInstanceInput struct { // The name for the master user. // - // Amazon Aurora + // This setting doesn't apply to Amazon Aurora DB instances. The name for the + // master user is managed by the DB cluster. // - // Not applicable. The name for the master user is managed by the DB cluster. - // - // Amazon RDS + // This setting is required for RDS DB instances. // // Constraints: // - // * Required. - // // * Must be 1 to 16 letters, numbers, or underscores. // // * First character must be a letter. @@ -21650,23 +21619,25 @@ type CreateDBInstanceInput struct { // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to the following DB instances: // - // Amazon Aurora + // * Amazon Aurora (Storage is managed by the DB cluster.) // - // Not applicable. Storage is managed by the DB cluster. + // * RDS Custom MaxAllocatedStorage *int64 `type:"integer"` // 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. The default is 0. + // 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. + // This setting doesn't apply to RDS Custom DB instances. // - // Valid Values: 0, 1, 5, 10, 15, 30, 60 + // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 + // + // Default: 0 MonitoringInterval *int64 `type:"integer"` // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics @@ -21678,54 +21649,44 @@ type CreateDBInstanceInput struct { // 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. + // This setting doesn't apply to RDS Custom DB instances. MonitoringRoleArn *string `type:"string"` - // A value that indicates whether the DB instance is a Multi-AZ deployment. - // You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ - // deployment. + // 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 RDS Custom. + // This setting doesn't apply to the following DB instances: // - // Amazon Aurora + // * Amazon Aurora (DB instance Availability Zones (AZs) are managed by the + // DB cluster.) // - // Not applicable. DB instance Availability Zones (AZs) are managed by the DB - // cluster. + // * RDS Custom MultiAZ *bool `type:"boolean"` // The name of the NCHAR character set for the Oracle DB instance. // - // This parameter doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. NcharCharacterSetName *string `type:"string"` // The network type of the DB instance. // - // Valid values: - // - // * IPV4 - // - // * DUAL - // // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. + // + // Valid Values: IPV4 | DUAL NetworkType *string `type:"string"` - // A value that indicates that the DB instance should be associated with the - // specified option group. + // 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 RDS Custom. - // - // Amazon Aurora - // - // Not applicable. + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. OptionGroupName *string `type:"string"` // The Amazon Web Services KMS key identifier for encryption of Performance @@ -21734,85 +21695,56 @@ type CreateDBInstanceInput struct { // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias // ARN, or alias name for the KMS key. // - // If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon + // 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. + // This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *string `type:"string"` - // The number of days to retain Performance Insights data. The default is 7 - // days. The following values are valid: + // The number of days to retain Performance Insights data. // - // * 7 + // This setting doesn't apply to RDS Custom DB instances. // - // * month * 31, where month is a number of months from 1-23 - // - // * 731 - // - // For example, the following values are valid: - // - // * 93 (3 months * 31) + // Valid Values: // - // * 341 (11 months * 31) + // * 7 // - // * 589 (19 months * 31) + // * 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 // - // If you specify a retention period such as 94, which isn't a valid value, - // RDS issues an error. + // Default: 7 days // - // This setting doesn't apply to RDS Custom. + // If you specify a retention period that isn't valid, such as 94, Amazon RDS + // returns an error. PerformanceInsightsRetentionPeriod *int64 `type:"integer"` // The port number on which the database accepts connections. // - // MySQL - // - // Default: 3306 - // - // Valid values: 1150-65535 - // - // Type: Integer - // - // MariaDB - // - // Default: 3306 - // - // Valid values: 1150-65535 + // This setting doesn't apply to Aurora DB instances. The port number is managed + // by the cluster. // - // Type: Integer - // - // PostgreSQL - // - // Default: 5432 - // - // Valid values: 1150-65535 - // - // Type: Integer - // - // Oracle + // Valid Values: 1150-65535 // - // Default: 1521 + // Default: // - // Valid values: 1150-65535 + // * RDS for MariaDB - 3306 // - // SQL Server + // * RDS for Microsoft SQL Server - 1433 // - // Default: 1433 + // * RDS for MySQL - 3306 // - // Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and - // 49152-49156. + // * RDS for Oracle - 1521 // - // Amazon Aurora + // * RDS for PostgreSQL - 5432 // - // Default: 3306 - // - // Valid values: 1150-65535 + // Constraints: // - // Type: Integer + // * For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, + // 3343, 3389, 47001, or 49152-49156. Port *int64 `type:"integer"` // The daily time range during which automated backups are created if automated @@ -21822,10 +21754,8 @@ type CreateDBInstanceInput struct { // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) // in the Amazon RDS User Guide. // - // Amazon Aurora - // - // Not applicable. The daily time range for creating automated backups is managed - // by the DB cluster. + // 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: // @@ -21838,44 +21768,46 @@ type CreateDBInstanceInput struct { // * Must be at least 30 minutes. PreferredBackupWindow *string `type:"string"` - // The time range each week during which system maintenance can occur, in Universal - // Coordinated Time (UTC). For more information, see Amazon RDS Maintenance - // Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance). - // - // Format: ddd:hh24:mi-ddd:hh24:mi + // The time range each week during which system maintenance can occur. For more + // information, see Amazon RDS Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) + // 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. // - // Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // Constraints: // - // Constraints: Minimum 30-minute window. + // * 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. PreferredMaintenanceWindow *string `type:"string"` // 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. - // - // Amazon Aurora - // - // Not applicable. + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that specifies the order in which an Aurora Replica is promoted to - // the primary instance after a failure of the existing primary instance. For - // more information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) // in the Amazon Aurora User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. // // Default: 1 // // Valid Values: 0 - 15 PromotionTier *int64 `type:"integer"` - // A value that indicates whether the DB instance is publicly accessible. + // 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 @@ -21909,35 +21841,32 @@ type CreateDBInstanceInput struct { // to it, the DB instance is public. PubliclyAccessible *bool `type:"boolean"` - // A value that indicates whether the DB instance is encrypted. By default, - // it isn't encrypted. - // - // For RDS Custom instances, either set this parameter to true or leave it unset. - // If you set this parameter to false, RDS reports an error. + // Specifes whether the DB instance is encrypted. By default, it isn't encrypted. // - // Amazon Aurora + // For RDS Custom DB instances, either enable this setting or leave it unset. + // Otherwise, Amazon RDS reports an error. // - // Not applicable. The encryption for DB instances is managed by the DB cluster. + // This setting doesn't apply to Amazon Aurora DB instances. The encryption + // for DB instances is managed by the DB cluster. StorageEncrypted *bool `type:"boolean"` - // Specifies the storage throughput value for the DB instance. + // The storage throughput value for the DB instance. // // This setting applies only to the gp3 storage type. // - // This setting doesn't apply to RDS Custom or Amazon Aurora. + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. StorageThroughput *int64 `type:"integer"` - // Specifies the storage type to be associated with the DB instance. - // - // Valid values: gp2 | gp3 | io1 | standard + // 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. // - // Default: io1 if the Iops parameter is specified, otherwise gp2 + // This setting doesn't apply to Amazon Aurora DB instances. Storage is managed + // by the DB cluster. // - // Amazon Aurora + // Valid Values: gp2 | gp3 | io1 | standard // - // Not applicable. Storage is managed by the DB cluster. + // Default: io1, if the Iops parameter is specified. Otherwise, gp2. StorageType *string `type:"string"` // Tags to assign to the DB instance. @@ -21945,17 +21874,13 @@ type CreateDBInstanceInput struct { // The ARN from the key store with which to associate the instance for TDE encryption. // - // This setting doesn't apply to RDS Custom. - // - // Amazon Aurora - // - // Not applicable. + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. TdeCredentialArn *string `type:"string"` // The password for the given ARN from the key store in order to access the // device. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. TdeCredentialPassword *string `type:"string"` // The time zone of the DB instance. The time zone parameter is currently supported @@ -21964,10 +21889,8 @@ type CreateDBInstanceInput struct { // A list of Amazon EC2 VPC security groups to associate with this DB instance. // - // Amazon Aurora - // - // Not applicable. The associated list of EC2 VPC security groups is managed - // by the DB cluster. + // 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. VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` @@ -24622,13 +24545,13 @@ type DBCluster struct { // instead automatically adjusts as needed. AllocatedStorage *int64 `type:"integer"` - // Provides 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. + // 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. AssociatedRoles []*DBClusterRole `locationNameList:"DBClusterRole" type:"list"` - // A value that indicates that minor version patches are applied automatically. + // Indicates whether minor version patches are applied automatically. // // This setting is only for non-Aurora Multi-AZ DB clusters. AutoMinorVersionUpgrade *bool `type:"boolean"` @@ -24636,8 +24559,8 @@ type DBCluster struct { // The time when a stopped DB cluster is restarted automatically. AutomaticRestartTime *time.Time `type:"timestamp"` - // Provides the list of Availability Zones (AZs) where instances in the DB cluster - // can be created. + // The list of Availability Zones (AZs) where instances in the DB cluster can + // be created. AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"` // The number of change records stored for Backtrack. @@ -24647,7 +24570,7 @@ type DBCluster struct { // is disabled for the DB cluster. Otherwise, backtracking is enabled. BacktrackWindow *int64 `type:"long"` - // Specifies the number of days for which automatic DB snapshots are retained. + // The number of days for which automatic DB snapshots are retained. BackupRetentionPeriod *int64 `type:"integer"` // The current capacity of an Aurora Serverless v1 DB cluster. The capacity @@ -24662,28 +24585,27 @@ type DBCluster struct { // associated with. CharacterSetName *string `type:"string"` - // Identifies the clone group to which the DB cluster is associated. + // The ID of the clone group with which the DB cluster is associated. CloneGroupId *string `type:"string"` - // Specifies the time when the DB cluster was created, in Universal Coordinated - // Time (UTC). + // The time when the DB cluster was created, in Universal Coordinated Time (UTC). ClusterCreateTime *time.Time `type:"timestamp"` - // Specifies whether tags are copied from the DB cluster to snapshots of the + // Indicates whether tags are copied from the DB cluster to snapshots of the // DB cluster. CopyTagsToSnapshot *bool `type:"boolean"` - // Specifies whether the DB cluster is a clone of a DB cluster owned by a different + // Indicates whether the DB cluster is a clone of a DB cluster owned by a different // Amazon Web Services account. CrossAccountClone *bool `type:"boolean"` - // Identifies all custom endpoints associated with the cluster. + // The custom endpoints associated with the DB cluster. CustomEndpoints []*string `type:"list"` // The Amazon Resource Name (ARN) for the DB cluster. DBClusterArn *string `type:"string"` - // Contains a user-supplied DB cluster identifier. This identifier is the unique + // The user-supplied identifier for the DB cluster. This identifier is the unique // key that identifies a DB cluster. DBClusterIdentifier *string `type:"string"` @@ -24692,25 +24614,25 @@ type DBCluster struct { // This setting is only for non-Aurora Multi-AZ DB clusters. DBClusterInstanceClass *string `type:"string"` - // Provides the list of instances that make up the DB cluster. + // The list of DB instances that make up the DB cluster. DBClusterMembers []*DBClusterMember `locationNameList:"DBClusterMember" type:"list"` - // Provides the list of option group memberships for this DB cluster. + // The list of option group memberships for this DB cluster. DBClusterOptionGroupMemberships []*DBClusterOptionGroupStatus `locationNameList:"DBClusterOptionGroup" type:"list"` - // Specifies the name of the DB cluster parameter group for the DB cluster. + // The name of the DB cluster parameter group for the DB cluster. DBClusterParameterGroup *string `type:"string"` - // Specifies information on the subnet group associated with the DB cluster, - // including the name, description, and subnets in the subnet group. + // Information about the subnet group associated with the DB cluster, including + // the name, description, and subnets in the subnet group. DBSubnetGroup *string `type:"string"` // Reserved for future use. DBSystemId *string `type:"string"` - // Contains the name of the initial database of this DB cluster that was provided - // at create time, if one was specified when the DB cluster was created. This - // same name is returned for the life of the DB cluster. + // 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. DatabaseName *string `type:"string"` // The Amazon Web Services Region-unique, immutable identifier for the DB cluster. @@ -24718,7 +24640,7 @@ type DBCluster struct { // the KMS key for the DB cluster is accessed. DbClusterResourceId *string `type:"string"` - // Indicates if the DB cluster has deletion protection enabled. The database + // Indicates whether the DB cluster has deletion protection enabled. The database // can't be deleted when deletion protection is enabled. DeletionProtection *bool `type:"boolean"` @@ -24740,10 +24662,10 @@ type DBCluster struct { // in the Amazon Aurora User Guide. EnabledCloudwatchLogsExports []*string `type:"list"` - // Specifies the connection endpoint for the primary instance of the DB cluster. + // The connection endpoint for the primary instance of the DB cluster. Endpoint *string `type:"string"` - // The name of the database engine to be used for this DB cluster. + // The database engine used for this DB cluster. Engine *string `type:"string"` // The DB engine mode of the DB cluster, either provisioned or serverless. @@ -24751,25 +24673,24 @@ type DBCluster struct { // For more information, see CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html). EngineMode *string `type:"string"` - // Indicates the database engine version. + // The version of the database engine. EngineVersion *string `type:"string"` - // Specifies whether you have requested to enable write forwarding 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. + // 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. GlobalWriteForwardingRequested *bool `type:"boolean"` - // Specifies whether a secondary cluster in an Aurora global database has write - // forwarding enabled, not enabled, or is in the process of enabling it. + // The status of write forwarding for a secondary cluster in an Aurora global + // database. GlobalWriteForwardingStatus *string `type:"string" enum:"WriteForwardingStatus"` - // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + // The ID that Amazon Route 53 assigns when you create a hosted zone. HostedZoneId *string `type:"string"` - // A value that indicates whether the HTTP endpoint for an Aurora Serverless - // v1 DB cluster is enabled. + // 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 @@ -24779,8 +24700,8 @@ type DBCluster struct { // in the Amazon Aurora User Guide. HttpEndpointEnabled *bool `type:"boolean"` - // A value that indicates whether the mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts is enabled. + // Indicates whether the mapping of Amazon Web Services Identity and Access + // Management (IAM) accounts to database accounts is enabled. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` // The next time you can modify the DB cluster to use the aurora-iopt1 storage @@ -24801,12 +24722,11 @@ type DBCluster struct { // ARN, or alias name for the KMS key. KmsKeyId *string `type:"string"` - // Specifies the latest time to which a database can be restored with point-in-time - // restore. + // The latest time to which a database can be restored with point-in-time restore. LatestRestorableTime *time.Time `type:"timestamp"` - // Contains the secret managed by RDS in Amazon Web Services Secrets Manager - // for the master user password. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) @@ -24815,7 +24735,7 @@ type DBCluster struct { // in the Amazon Aurora User Guide. MasterUserSecret *MasterUserSecret `type:"structure"` - // Contains the master username for the DB cluster. + // The master username for the DB cluster. MasterUsername *string `type:"string"` // The interval, in seconds, between points when Enhanced Monitoring metrics @@ -24830,17 +24750,11 @@ type DBCluster struct { // This setting is only for non-Aurora Multi-AZ DB clusters. MonitoringRoleArn *string `type:"string"` - // Specifies whether the DB cluster has instances in multiple Availability Zones. + // Indicates whether the DB cluster has instances in multiple Availability Zones. MultiAZ *bool `type:"boolean"` // The network type of the DB instance. // - // Valid values: - // - // * IPV4 - // - // * DUAL - // // 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). @@ -24849,18 +24763,19 @@ type DBCluster struct { // in the Amazon Aurora User Guide. // // This setting is only for Aurora DB clusters. + // + // Valid Values: IPV4 | DUAL NetworkType *string `type:"string"` - // A value that specifies that changes to the DB cluster are pending. This element - // is only included when changes are pending. Specific changes are identified + // Information about pending changes to the DB cluster. This information is + // returned only when there are pending changes. Specific changes are identified // by subelements. PendingModifiedValues *ClusterPendingModifiedValues `type:"structure"` - // Specifies the progress of the operation as a percentage. + // The progress of the operation as a percentage. PercentProgress *string `type:"string"` - // True if Performance Insights is enabled for the DB cluster, and otherwise - // false. + // Indicates whether Performance Insights is enabled for the DB cluster. // // This setting is only for non-Aurora Multi-AZ DB clusters. PerformanceInsightsEnabled *bool `type:"boolean"` @@ -24874,52 +24789,46 @@ type DBCluster struct { // This setting is only for non-Aurora Multi-AZ DB clusters. PerformanceInsightsKMSKeyId *string `type:"string"` - // The number of days to retain Performance Insights data. The default is 7 - // days. The following values are valid: - // - // * 7 + // The number of days to retain Performance Insights data. // - // * month * 31, where month is a number of months from 1-23 - // - // * 731 - // - // For example, the following values are valid: + // This setting is only for non-Aurora Multi-AZ DB clusters. // - // * 93 (3 months * 31) + // Valid Values: // - // * 341 (11 months * 31) + // * 7 // - // * 589 (19 months * 31) + // * 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 // - // This setting is only for non-Aurora Multi-AZ DB clusters. + // Default: 7 days PerformanceInsightsRetentionPeriod *int64 `type:"integer"` - // Specifies the port that the database engine is listening on. + // The port that the database engine is listening on. Port *int64 `type:"integer"` - // Specifies the daily time range during which automated backups are created - // if automated backups are enabled, as determined by the BackupRetentionPeriod. + // The daily time range during which automated backups are created if automated + // backups are enabled, as determined by the BackupRetentionPeriod. PreferredBackupWindow *string `type:"string"` - // Specifies the weekly time range during which system maintenance can occur, - // in Universal Coordinated Time (UTC). + // The weekly time range during which system maintenance can occur, in Universal + // Coordinated Time (UTC). PreferredMaintenanceWindow *string `type:"string"` - // Specifies the accessibility options for the DB instance. + // Indicates whether the DB cluster 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 + // 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 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. + // 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 + // 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 CreateDBInstance. + // For more information, see CreateDBCluster. // // This setting is only for non-Aurora Multi-AZ DB clusters. PubliclyAccessible *bool `type:"boolean"` @@ -24941,27 +24850,26 @@ type DBCluster struct { // then reconnect to the reader endpoint. ReaderEndpoint *string `type:"string"` - // Contains the identifier of the source DB cluster if this DB cluster is a - // read replica. + // The identifier of the source DB cluster if this DB cluster is a read replica. ReplicationSourceIdentifier *string `type:"string"` - // Shows the scaling configuration for an Aurora DB cluster in serverless DB - // engine mode. + // The scaling configuration for an Aurora DB cluster in serverless DB engine + // mode. // // For more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) // in the Amazon Aurora User Guide. ScalingConfigurationInfo *ScalingConfigurationInfo `type:"structure"` - // Shows the scaling configuration for an Aurora Serverless v2 DB cluster. + // The scaling configuration for an Aurora Serverless v2 DB cluster. // // For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfigurationInfo `type:"structure"` - // Specifies the current state of this DB cluster. + // The current state of this DB cluster. Status *string `type:"string"` - // Specifies whether the DB cluster is encrypted. + // Indicates whether the DB cluster is encrypted. StorageEncrypted *bool `type:"boolean"` // The storage type associated with the DB cluster. @@ -24971,7 +24879,7 @@ type DBCluster struct { // in the Amazon RDS User Guide. TagList []*Tag `locationNameList:"Tag" type:"list"` - // Provides a list of VPC security groups that the DB cluster belongs to. + // The list of VPC security groups that the DB cluster belongs to. VpcSecurityGroups []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroupMembership" type:"list"` } @@ -26576,14 +26484,14 @@ type DBInstance struct { // The status of the database activity stream. ActivityStreamStatus *string `type:"string" enum:"ActivityStreamStatus"` - // Specifies the allocated storage size specified in gibibytes (GiB). + // The amount of storage in gibibytes (GiB) allocated for the DB instance. AllocatedStorage *int64 `type:"integer"` // The Amazon Web Services Identity and Access Management (IAM) roles associated // with the DB instance. AssociatedRoles []*DBInstanceRole `locationNameList:"DBInstanceRole" type:"list"` - // A value that indicates that minor version patches are applied automatically. + // Indicates whether minor version patches are applied automatically. AutoMinorVersionUpgrade *bool `type:"boolean"` // The time when a stopped DB instance is restarted automatically. @@ -26594,17 +26502,17 @@ type DBInstance struct { // paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes. AutomationMode *string `type:"string" enum:"AutomationMode"` - // Specifies the name of the Availability Zone the DB instance is located in. + // The name of the Availability Zone where the DB instance is located. AvailabilityZone *string `type:"string"` // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services // Backup. AwsBackupRecoveryPointArn *string `type:"string"` - // Specifies the number of days for which automatic DB snapshots are retained. + // The number of days for which automatic DB snapshots are retained. BackupRetentionPeriod *int64 `type:"integer"` - // Specifies where automated backups and manual snapshots are stored: Amazon + // The location where automated backups and manual snapshots are stored: Amazon // Web Services Outposts or the Amazon Web Services Region. BackupTarget *string `type:"string"` @@ -26624,14 +26532,13 @@ type DBInstance struct { // associated with. CharacterSetName *string `type:"string"` - // Specifies whether tags are copied from the DB instance to snapshots of the + // Indicates whether tags are copied from the DB instance to snapshots of the // DB instance. // - // Amazon Aurora - // - // Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting - // this value for an Aurora DB instance has no effect on the DB cluster setting. - // For more information, see DBCluster. + // 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. CopyTagsToSnapshot *bool `type:"boolean"` // The instance profile associated with the underlying Amazon EC2 instance of @@ -26650,7 +26557,7 @@ type DBInstance struct { // in the Amazon RDS User Guide. CustomIamInstanceProfile *string `type:"string"` - // Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS + // 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 @@ -26666,7 +26573,7 @@ type DBInstance struct { // in the Amazon Web Services Outposts User Guide. CustomerOwnedIpEnabled *bool `type:"boolean"` - // If the DB instance is a member of a DB cluster, contains the name of the + // 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. DBClusterIdentifier *string `type:"string"` @@ -26676,54 +26583,49 @@ type DBInstance struct { // The list of replicated automated backups associated with the DB instance. DBInstanceAutomatedBackupsReplications []*DBInstanceAutomatedBackupsReplication `locationNameList:"DBInstanceAutomatedBackupsReplication" type:"list"` - // Contains the name of the compute and memory capacity class of the DB instance. + // The name of the compute and memory capacity class of the DB instance. DBInstanceClass *string `type:"string"` - // Contains a user-supplied database identifier. This identifier is the unique - // key that identifies a DB instance. + // The user-supplied database identifier. This identifier is the unique key + // that identifies a DB instance. DBInstanceIdentifier *string `type:"string"` - // Specifies the current state of this database. + // The current state of this database. // // For information about DB instance statuses, see Viewing DB instance status // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status) // in the Amazon RDS User Guide. DBInstanceStatus *string `type:"string"` - // The meaning of this parameter differs according to the database engine you - // use. - // - // MySQL, MariaDB, SQL Server, PostgreSQL - // - // Contains the name of the initial database of this instance that was provided - // at create time, if one was specified when the DB instance was created. This - // same name is returned for the life of the DB instance. - // - // Type: String + // The meaning of this parameter differs depending on the database engine. // - // Oracle + // * 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. // - // Contains the Oracle System ID (SID) of the created DB instance. Not shown - // when the returned parameters do not apply to an Oracle DB instance. + // * 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. DBName *string `type:"string"` - // Provides the list of DB parameter groups applied to this DB instance. + // The list of DB parameter groups applied to this DB instance. DBParameterGroups []*DBParameterGroupStatus `locationNameList:"DBParameterGroup" type:"list"` // A list of DB security group elements containing DBSecurityGroup.Name and // DBSecurityGroup.Status subelements. DBSecurityGroups []*DBSecurityGroupMembership `locationNameList:"DBSecurityGroup" type:"list"` - // Specifies information on the subnet group associated with the DB instance, - // including the name, description, and subnets in the subnet group. + // Information about the subnet group associated with the DB instance, including + // the name, description, and subnets in the subnet group. DBSubnetGroup *DBSubnetGroup `type:"structure"` // 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 only. + // SID is also the name of the CDB. This setting is only valid for RDS Custom + // DB instances. DBSystemId *string `type:"string"` - // Specifies the port that the DB instance listens on. If the DB instance is - // part of a DB cluster, this can be a different port than the DB cluster port. + // 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. DbInstancePort *int64 `type:"integer"` // The Amazon Web Services Region-unique, immutable identifier for the DB instance. @@ -26731,7 +26633,7 @@ type DBInstance struct { // the Amazon Web Services KMS key for the DB instance is accessed. DbiResourceId *string `type:"string"` - // Indicates if the DB instance has deletion protection enabled. The database + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` @@ -26743,27 +26645,27 @@ type DBInstance struct { // Logs. // // Log types vary by DB engine. For information about the log types for each - // DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) + // DB engine, see Monitoring Amazon RDS log files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) // in the Amazon RDS User Guide. EnabledCloudwatchLogsExports []*string `type:"list"` - // Specifies the connection endpoint. + // The connection endpoint for the DB instance. // - // The endpoint might not be shown for instances whose status is creating. + // The endpoint might not be shown for instances with the status of creating. Endpoint *Endpoint `type:"structure"` - // The name of the database engine to be used for this DB instance. + // The database engine used for this DB instance. Engine *string `type:"string"` - // Indicates the database engine version. + // The version of the database engine. EngineVersion *string `type:"string"` // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that // receives the Enhanced Monitoring metrics data for the DB instance. EnhancedMonitoringResourceArn *string `type:"string"` - // True if mapping of Amazon Web Services Identity and Access Management (IAM) - // accounts to database accounts is enabled, and otherwise false. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.html) @@ -26771,39 +26673,39 @@ type DBInstance struct { // in the Amazon Aurora User Guide. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` - // Provides the date and time the DB instance was created. + // The date and time when the DB instance was created. InstanceCreateTime *time.Time `type:"timestamp"` - // Specifies the Provisioned IOPS (I/O operations per second) value. + // The Provisioned IOPS (I/O operations per second) value for the DB instance. Iops *int64 `type:"integer"` - // If StorageEncrypted is true, the Amazon Web Services KMS key identifier for - // the encrypted DB instance. + // 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. KmsKeyId *string `type:"string"` - // Specifies the latest time to which a database can be restored with point-in-time - // restore. + // The latest time to which a database in this DB instance can be restored with + // point-in-time restore. LatestRestorableTime *time.Time `type:"timestamp"` - // License model information for this DB instance. This setting doesn't apply - // to RDS Custom. + // The license model information for this DB instance. This setting doesn't + // apply to RDS Custom DB instances. LicenseModel *string `type:"string"` - // Specifies the listener connection endpoint for SQL Server Always On. + // The listener connection endpoint for SQL Server Always On. ListenerEndpoint *Endpoint `type:"structure"` - // Contains the secret managed by RDS in Amazon Web Services Secrets Manager - // for the master user password. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide. MasterUserSecret *MasterUserSecret `type:"structure"` - // Contains the master username for the DB instance. + // The master username for the DB instance. MasterUsername *string `type:"string"` // The upper limit in gibibytes (GiB) to which Amazon RDS can automatically @@ -26818,8 +26720,8 @@ type DBInstance struct { // to Amazon CloudWatch Logs. MonitoringRoleArn *string `type:"string"` - // Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't - // apply to RDS Custom. + // Indicates whether the DB instance is a Multi-AZ deployment. This setting + // doesn't apply to RDS Custom DB instances. MultiAZ *bool `type:"boolean"` // The name of the NCHAR character set for the Oracle DB instance. This character @@ -26829,12 +26731,6 @@ type DBInstance struct { // The network type of the DB instance. // - // Valid values: - // - // * IPV4 - // - // * DUAL - // // 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). @@ -26842,18 +26738,19 @@ type DBInstance struct { // For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide and Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. + // + // Valid Values: IPV4 | DUAL NetworkType *string `type:"string"` - // Provides the list of option group memberships for this DB instance. + // The list of option group memberships for this DB instance. OptionGroupMemberships []*OptionGroupMembership `locationNameList:"OptionGroupMembership" type:"list"` - // A value that specifies that changes to the DB instance are pending. This - // element is only included when changes are pending. Specific changes are identified + // Information about pending changes to the DB instance. This information is + // returned only when there are pending changes. Specific changes are identified // by subelements. PendingModifiedValues *PendingModifiedValues `type:"structure"` - // True if Performance Insights is enabled for the DB instance, and otherwise - // false. + // Indicates whether Performance Insights is enabled for the DB instance. PerformanceInsightsEnabled *bool `type:"boolean"` // The Amazon Web Services KMS key identifier for encryption of Performance @@ -26863,45 +26760,39 @@ type DBInstance struct { // ARN, or alias name for the KMS key. PerformanceInsightsKMSKeyId *string `type:"string"` - // The number of days to retain Performance Insights data. The default is 7 - // days. The following values are valid: + // The number of days to retain Performance Insights data. + // + // Valid Values: // // * 7 // - // * month * 31, where month is a number of months from 1-23 + // * 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 // - // For example, the following values are valid: - // - // * 93 (3 months * 31) - // - // * 341 (11 months * 31) - // - // * 589 (19 months * 31) - // - // * 731 + // Default: 7 days PerformanceInsightsRetentionPeriod *int64 `type:"integer"` - // Specifies the daily time range during which automated backups are created - // if automated backups are enabled, as determined by the BackupRetentionPeriod. + // The daily time range during which automated backups are created if automated + // backups are enabled, as determined by the BackupRetentionPeriod. PreferredBackupWindow *string `type:"string"` - // Specifies the weekly time range during which system maintenance can occur, - // in Universal Coordinated Time (UTC). + // The weekly time range during which system maintenance can occur, in Universal + // Coordinated Time (UTC). PreferredMaintenanceWindow *string `type:"string"` // The number of CPU cores and the number of threads per core for the DB instance // class of the DB instance. ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that specifies the order in which an Aurora Replica is promoted to - // the primary instance after a failure of the existing primary instance. For - // more information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) // in the Amazon Aurora User Guide. PromotionTier *int64 `type:"integer"` - // Specifies the accessibility options for the DB instance. + // 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 @@ -26916,25 +26807,22 @@ type DBInstance struct { // For more information, see CreateDBInstance. PubliclyAccessible *bool `type:"boolean"` - // Contains one or more identifiers of Aurora DB clusters to which the RDS DB - // instance is replicated as a read replica. For example, when you create an - // Aurora read replica of an RDS 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. + // 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. ReadReplicaDBClusterIdentifiers []*string `locationNameList:"ReadReplicaDBClusterIdentifier" type:"list"` - // Contains one or more identifiers of the read replicas associated with this - // DB instance. + // The identifiers of the read replicas associated with this DB instance. ReadReplicaDBInstanceIdentifiers []*string `locationNameList:"ReadReplicaDBInstanceIdentifier" type:"list"` - // Contains the identifier of the source DB cluster if this DB instance is a - // read replica. + // The identifier of the source DB cluster if this DB instance is a read replica. ReadReplicaSourceDBClusterIdentifier *string `type:"string"` - // Contains the identifier of the source DB instance if this DB instance is - // a read replica. + // The identifier of the source DB instance if this DB instance is a read replica. ReadReplicaSourceDBInstanceIdentifier *string `type:"string"` // The open mode of an Oracle read replica. The default is open-read-only. For @@ -26953,19 +26841,19 @@ type DBInstance struct { // instance with multi-AZ support. SecondaryAvailabilityZone *string `type:"string"` - // The status of a read replica. If the instance isn't a read replica, this - // is blank. + // The status of a read replica. If the DB instance isn't a read replica, the + // value is blank. StatusInfos []*DBInstanceStatusInfo `locationNameList:"DBInstanceStatusInfo" type:"list"` - // Specifies whether the DB instance is encrypted. + // Indicates whether the DB instance is encrypted. StorageEncrypted *bool `type:"boolean"` - // Specifies the storage throughput for the DB instance. + // The storage throughput for the DB instance. // // This setting applies only to the gp3 storage type. StorageThroughput *int64 `type:"integer"` - // Specifies the storage type associated with the DB instance. + // The storage type associated with the DB instance. StorageType *string `type:"string"` // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) @@ -26981,8 +26869,7 @@ type DBInstance struct { // that were created with a time zone specified. Timezone *string `type:"string"` - // Provides a list of VPC security group elements that the DB instance belongs - // to. + // The list of Amazon EC2 VPC security groups that the DB instance belongs to. VpcSecurityGroups []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroupMembership" type:"list"` } @@ -32602,17 +32489,17 @@ type DescribeDBClustersInput struct { _ struct{} `type:"structure"` // The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) - // of the DB cluster. If this parameter is specified, information from only - // the specific DB cluster is returned. This parameter isn't case-sensitive. + // 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 DBClusterIdentifier. + // * If supplied, must match an existing DB cluster identifier. DBClusterIdentifier *string `type:"string"` // A filter that specifies one or more DB clusters to describe. // - // Supported filters: + // Supported Filters: // // * clone-group-id - Accepts clone group identifiers. The results list only // includes information about the DB clusters associated with these clone @@ -32633,8 +32520,8 @@ type DescribeDBClustersInput struct { // about the DB clusters for these engines. Filters []*Filter `locationNameList:"Filter" type:"list"` - // Optional Boolean parameter that specifies whether the output includes information - // about clusters shared from other Amazon Web Services accounts. + // Specifies whether the output includes information about clusters shared from + // other Amazon Web Services accounts. IncludeShared *bool `type:"boolean"` // An optional pagination token provided by a previous DescribeDBClusters request. @@ -33199,12 +33086,12 @@ type DescribeDBInstancesInput struct { // // Constraints: // - // * If supplied, must match the identifier of an existing DBInstance. + // * If supplied, must match the identifier of an existing DB instance. DBInstanceIdentifier *string `type:"string"` // A filter that specifies one or more DB instances to describe. // - // Supported filters: + // Supported Filters: // // * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon // Resource Names (ARNs). The results list only includes information about @@ -33215,8 +33102,8 @@ type DescribeDBInstancesInput struct { // the DB instances identified by these ARNs. // // * dbi-resource-id - Accepts DB instance resource identifiers. The results - // list will only include information about the DB instances identified by - // these DB instance resource identifiers. + // 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. @@ -40149,32 +40036,35 @@ type ModifyDBClusterInput struct { // 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 + // Valid for Cluster Type: Multi-AZ DB clusters only AllocatedStorage *int64 `type:"integer"` - // A value that indicates whether engine mode changes from serverless to provisioned - // are allowed. + // Specifies whether engine mode changes from serverless to provisioned are + // allowed. // - // Constraints: You must allow engine mode changes when specifying a different - // value for the EngineMode parameter from the DB cluster's current engine mode. + // Valid for Cluster Type: Aurora Serverless v1 DB clusters only + // + // Constraints: // - // Valid for: Aurora Serverless v1 DB clusters only + // * You must allow engine mode changes when specifying a different value + // for the EngineMode parameter from the DB cluster's current engine mode. AllowEngineModeChange *bool `type:"boolean"` - // A value that indicates whether major version upgrades are allowed. + // Specifies whether major version upgrades are allowed. // - // Constraints: You must allow major version upgrades when specifying a value - // for the EngineVersion parameter that is a different major version than the - // DB cluster's current version. + // Valid for Cluster Type: Aurora DB clusters only // - // Valid for: 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. AllowMajorVersionUpgrade *bool `type:"boolean"` - // A value that indicates whether the modifications in this request and any - // pending modifications are asynchronously applied as soon as possible, regardless - // of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter - // is disabled, changes to the DB cluster are applied during the next maintenance - // window. + // 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 @@ -40183,60 +40073,55 @@ type ModifyDBClusterInput struct { // // By default, this parameter is disabled. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters ApplyImmediately *bool `type:"boolean"` - // A value that indicates whether minor engine upgrades are applied automatically - // to the DB cluster during the maintenance window. By default, minor engine - // upgrades are applied automatically. + // 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: Multi-AZ DB clusters only + // Valid for Cluster Type: Multi-AZ DB clusters only AutoMinorVersionUpgrade *bool `type:"boolean"` // 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). - // - // Valid for: Aurora MySQL DB clusters only BacktrackWindow *int64 `type:"long"` // 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 - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * Must be a value from 1 to 35. BackupRetentionPeriod *int64 `type:"integer"` // The configuration setting for the log types to be enabled for export to CloudWatch - // Logs for a specific DB cluster. The values in the list depend on the DB engine - // being used. - // - // RDS for MySQL + // Logs for a specific DB cluster. // - // Possible values are error, general, and slowquery. + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // - // RDS for PostgreSQL + // The following values are valid for each DB engine: // - // Possible values are postgresql and upgrade. + // * Aurora MySQL - audit | error | general | slowquery // - // Aurora MySQL + // * Aurora PostgreSQL - postgresql // - // Possible values are audit, error, general, and slowquery. - // - // Aurora PostgreSQL + // * RDS for MySQL - error | general | slowquery // - // Possible value is postgresql. + // * RDS for PostgreSQL - postgresql | upgrade // // For more information about exporting CloudWatch Logs for Amazon RDS, see // Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) @@ -40245,23 +40130,22 @@ type ModifyDBClusterInput struct { // For more information about exporting CloudWatch Logs for Amazon Aurora, see // Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon Aurora User Guide. - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"` - // A value that indicates whether to copy all tags from the DB cluster to snapshots - // of the DB cluster. The default is not to copy them. + // 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: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters CopyTagsToSnapshot *bool `type:"boolean"` // The DB cluster identifier for the cluster being modified. This parameter // isn't case-sensitive. // - // Constraints: This identifier must match the identifier of an existing DB - // cluster. + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Constraints: + // + // * Must match the identifier of an existing DB cluster. // // DBClusterIdentifier is a required field DBClusterIdentifier *string `type:"string" required:"true"` @@ -40274,12 +40158,12 @@ type ModifyDBClusterInput struct { // see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. // - // Valid for: Multi-AZ DB clusters only + // Valid for Cluster Type: Multi-AZ DB clusters only DBClusterInstanceClass *string `type:"string"` // The name of the DB cluster parameter group to use for the DB cluster. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DBClusterParameterGroupName *string `type:"string"` // The name of the DB parameter group to apply to all instances of the DB cluster. @@ -40288,6 +40172,8 @@ type ModifyDBClusterInput struct { // 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: @@ -40297,15 +40183,13 @@ type ModifyDBClusterInput struct { // // * The DBInstanceParameterGroupName parameter is valid in combination with // the AllowMajorVersionUpgrade parameter for a major version upgrade only. - // - // Valid for: Aurora DB clusters only DBInstanceParameterGroupName *string `type:"string"` - // A value that indicates whether the DB cluster has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. + // 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: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DeletionProtection *bool `type:"boolean"` // The Active Directory directory ID to move the DB cluster to. Specify none @@ -40315,32 +40199,31 @@ type ModifyDBClusterInput struct { // For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only Domain *string `type:"string"` - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. + // The name of the IAM role to use when making API calls to the Directory Service. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only DomainIAMRoleName *string `type:"string"` - // A value that indicates whether to enable this DB cluster to forward write - // operations to the primary cluster of an Aurora global database (GlobalCluster). - // By default, write operations are not allowed on Aurora DB clusters that are - // secondary clusters in an Aurora global database. + // 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 + // 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 the FailoverGlobalCluster API operation, but it does nothing until then. + // by a global cluster API operation, but it does nothing until then. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only EnableGlobalWriteForwarding *bool `type:"boolean"` - // A value that indicates whether to enable the HTTP endpoint for an Aurora - // Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. + // 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 @@ -40349,26 +40232,25 @@ type ModifyDBClusterInput struct { // For more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only EnableHttpEndpoint *bool `type:"boolean"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to turn on Performance Insights for the DB - // cluster. + // Specifies whether to turn on Performance Insights for the DB cluster. // // For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. // - // Valid for: Multi-AZ DB clusters only + // Valid for Cluster Type: Multi-AZ DB clusters only EnablePerformanceInsights *bool `type:"boolean"` // The DB engine mode of the DB cluster, either provisioned or serverless. @@ -40377,7 +40259,7 @@ type ModifyDBClusterInput struct { // // For more information, see CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html). // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only EngineMode *string `type:"string"` // The version number of the database engine to which you want to upgrade. Changing @@ -40408,7 +40290,7 @@ type ModifyDBClusterInput struct { // // aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion" // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters EngineVersion *string `type:"string"` // The amount of Provisioned IOPS (input/output operations per second) to be @@ -40418,14 +40300,16 @@ type ModifyDBClusterInput struct { // storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) // in the Amazon RDS User Guide. // - // Constraints: Must be a multiple between .5 and 50 of the storage amount for - // the DB cluster. + // Valid for Cluster Type: Multi-AZ DB clusters only // - // Valid for: Multi-AZ DB clusters only + // Constraints: + // + // * Must be a multiple between .5 and 50 of the storage amount for the DB + // cluster. Iops *int64 `type:"integer"` - // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. + // 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, @@ -40443,19 +40327,20 @@ type ModifyDBClusterInput struct { // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters ManageMasterUserPassword *bool `type:"boolean"` - // The new password for the master database user. This password can contain - // any printable ASCII character except "/", """, or "@". + // 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't be specified if ManageMasterUserPassword is turned on. + // * Can contain any printable ASCII character except "/", """, or "@". // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * Can't be specified if ManageMasterUserPassword is turned on. MasterUserPassword *string `type:"string"` // The Amazon Web Services KMS key identifier to encrypt a secret that is automatically @@ -40484,19 +40369,21 @@ type ModifyDBClusterInput struct { // 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 + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *string `type:"string"` // 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. The default is 0. + // metrics, specify 0. // // If MonitoringRoleArn is specified, also set MonitoringInterval to a value // other than 0. // - // Valid Values: 0, 1, 5, 10, 15, 30, 60 + // Valid for Cluster Type: Multi-AZ DB clusters only // - // Valid for: Multi-AZ DB clusters only + // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 + // + // Default: 0 MonitoringInterval *int64 `type:"integer"` // The Amazon Resource Name (ARN) for the IAM role that permits RDS to send @@ -40508,17 +40395,11 @@ type ModifyDBClusterInput struct { // If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn // value. // - // Valid for: Multi-AZ DB clusters only + // Valid for Cluster Type: Multi-AZ DB clusters only MonitoringRoleArn *string `type:"string"` // The network type of the DB cluster. // - // Valid values: - // - // * IPV4 - // - // * DUAL - // // 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). @@ -40526,27 +40407,28 @@ type ModifyDBClusterInput struct { // For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. // - // Valid for: Aurora DB clusters only + // Valid for Cluster Type: Aurora DB clusters only + // + // Valid Values: IPV4 | DUAL NetworkType *string `type:"string"` // 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 + // * Must contain from 1 to 63 letters, numbers, or hyphens. // - // * The first character must be a letter + // * The first character must be a letter. // - // * Can't end with a hyphen or contain two consecutive hyphens + // * Can't end with a hyphen or contain two consecutive hyphens. // // Example: my-cluster2 - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters NewDBClusterIdentifier *string `type:"string"` - // A value that indicates that the DB cluster should be associated with the - // specified option group. + // The option group to associate the DB cluster with. // // DB clusters are associated with a default option group that can't be modified. OptionGroupName *string `type:"string"` @@ -40562,41 +40444,35 @@ type ModifyDBClusterInput struct { // 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 + // Valid for Cluster Type: Multi-AZ DB clusters only PerformanceInsightsKMSKeyId *string `type:"string"` - // The number of days to retain Performance Insights data. The default is 7 - // days. The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of months from 1-23 - // - // * 731 + // The number of days to retain Performance Insights data. // - // For example, the following values are valid: + // Valid for Cluster Type: Multi-AZ DB clusters only // - // * 93 (3 months * 31) + // Valid Values: // - // * 341 (11 months * 31) + // * 7 // - // * 589 (19 months * 31) + // * 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 // - // If you specify a retention period such as 94, which isn't a valid value, - // RDS issues an error. + // Default: 7 days // - // Valid for: Multi-AZ DB clusters only + // If you specify a retention period that isn't valid, such as 94, Amazon RDS + // issues an error. PerformanceInsightsRetentionPeriod *int64 `type:"integer"` // The port number on which the DB cluster accepts connections. // - // Constraints: Value must be 1150-65535 + // Valid for Cluster Type: Aurora DB clusters only // - // Default: The same port as the original DB cluster. + // Valid Values: 1150-65535 // - // Valid for: Aurora DB clusters only + // Default: The same port as the original DB cluster. Port *int64 `type:"integer"` // The daily time range during which automated backups are created if automated @@ -40607,6 +40483,8 @@ type ModifyDBClusterInput struct { // see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) // 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. @@ -40616,14 +40494,12 @@ type ModifyDBClusterInput struct { // * Must not conflict with the preferred maintenance window. // // * Must be at least 30 minutes. - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters PreferredBackupWindow *string `type:"string"` // The weekly time range during which system maintenance can occur, in Universal // Coordinated Time (UTC). // - // Format: ddd:hh24:mi-ddd:hh24:mi + // 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 @@ -40631,15 +40507,19 @@ type ModifyDBClusterInput struct { // Cluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) // in the Amazon Aurora User Guide. // - // Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + // Constraints: // - // Constraints: Minimum 30-minute window. + // * Must be in the format ddd:hh24:mi-ddd:hh24:mi. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * 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. PreferredMaintenanceWindow *string `type:"string"` - // A value that indicates whether to rotate the secret managed by Amazon Web - // Services Secrets Manager for the master user password. + // 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 @@ -40651,18 +40531,18 @@ type ModifyDBClusterInput struct { // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // 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. - // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters RotateMasterUserPassword *bool `type:"boolean"` // 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 + // Valid for Cluster Type: Aurora DB clusters only ScalingConfiguration *ScalingConfiguration `type:"structure"` // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. @@ -40671,22 +40551,34 @@ type ModifyDBClusterInput struct { // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *ServerlessV2ScalingConfiguration `type:"structure"` - // Specifies the storage type to be associated with the DB cluster. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type). + // For information on storage types for Multi-AZ DB clusters, see Settings for + // creating Multi-AZ DB clusters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings). // // When specified for a Multi-AZ DB cluster, a value for the Iops parameter // is required. // - // Valid values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB - // clusters) + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters // - // Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters) + // Valid Values: // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // * Aurora DB clusters - aurora | aurora-iopt1 + // + // * Multi-AZ DB clusters - io1 + // + // Default: + // + // * Aurora DB clusters - aurora + // + // * Multi-AZ DB clusters - io1 StorageType *string `type:"string"` - // A list of VPC security groups that the DB cluster will belong to. + // A list of EC2 VPC security groups to associate with this DB cluster. // - // Valid for: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` } @@ -41228,29 +41120,30 @@ type ModifyDBInstanceInput struct { // 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 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. AllocatedStorage *int64 `type:"integer"` - // A value that indicates whether major version upgrades are allowed. Changing - // this parameter doesn't result in an outage and the change is asynchronously - // applied as soon as possible. + // 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. + // 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 is a different major version than the - // DB instance's current version. + // 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. AllowMajorVersionUpgrade *bool `type:"boolean"` - // A value that indicates whether the modifications in this request and any - // pending modifications are asynchronously applied as soon as possible, regardless - // of the PreferredMaintenanceWindow setting for the DB instance. By default, - // this parameter is disabled. + // 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 @@ -41260,9 +41153,9 @@ type ModifyDBInstanceInput struct { // for each modified parameter and to determine when the changes are applied. ApplyImmediately *bool `type:"boolean"` - // A value that indicates 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: + // 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. // @@ -41270,22 +41163,22 @@ type ModifyDBInstanceInput struct { // // * RDS has enabled automatic patching for the engine version. // - // If any of the preceding conditions isn't met, RDS applies the change as soon - // as possible and doesn't cause an outage. + // 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, set AutoMinorVersionUpgrade to false. Otherwise, - // the operation returns an error. + // For an RDS Custom DB instance, don't enable this setting. Otherwise, the + // operation returns an error. AutoMinorVersionUpgrade *bool `type:"boolean"` - // The automation mode of the RDS Custom DB instance: full or all paused. If - // full, the DB instance automates monitoring and instance recovery. If all - // paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes. + // 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. AutomationMode *string `type:"string" enum:"AutomationMode"` // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services // Backup. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. AwsBackupRecoveryPointArn *string `min:"43" type:"string"` // The number of days to retain automated backups. Setting this parameter to @@ -41301,30 +41194,24 @@ type ModifyDBInstanceInput struct { // non-zero value to another non-zero value, the change is asynchronously applied // as soon as possible. // - // Amazon Aurora - // - // Not applicable. The retention period for automated backups is managed by - // the DB cluster. For more information, see ModifyDBCluster. + // 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: // - // * It must be a value from 0 to 35. It can't be set to 0 if the DB instance - // is a source to read replicas. It can't be set to 0 for an RDS Custom for - // Oracle DB instance. + // * Must be a value from 0 to 35. // - // * It can be specified for a MySQL read replica only if the source is running - // MySQL 5.6 or later. + // * Can't be set to 0 if the DB instance is a source to read replicas. // - // * It can be specified for a PostgreSQL read replica only if the source - // is running PostgreSQL 9.3.5. + // * Can't be set to 0 for an RDS Custom for Oracle DB instance. BackupRetentionPeriod *int64 `type:"integer"` - // Specifies the CA certificate identifier to use for the DB instance’s server - // certificate. + // The CA certificate identifier to use for the DB instance6's server certificate. // - // This setting doesn't apply to RDS Custom. + // 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 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) @@ -41333,8 +41220,8 @@ type ModifyDBInstanceInput struct { // in the Amazon Aurora User Guide. CACertificateIdentifier *string `type:"string"` - // A value that indicates whether the DB instance is restarted when you rotate - // your SSL/TLS certificate. + // 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. @@ -41353,27 +41240,26 @@ type ModifyDBInstanceInput struct { // DB engines, see Rotating Your SSL/TLS Certificate (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) // in the Amazon Aurora User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. CertificateRotationRestart *bool `type:"boolean"` - // The configuration setting for the log types to be enabled for export to CloudWatch - // Logs for a specific DB instance. + // 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. + // This setting doesn't apply to RDS Custom DB instances. CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"` - // A value that indicates whether to copy all tags from the DB instance to snapshots - // of the DB instance. By default, tags are not copied. + // Specifies whether to copy all tags from the DB instance to snapshots of the + // DB instance. By default, tags aren't copied. // - // Amazon Aurora - // - // Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting - // this value for an Aurora DB instance has no effect on the DB cluster setting. - // For more information, see ModifyDBCluster. + // 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. CopyTagsToSnapshot *bool `type:"boolean"` // The new compute and memory capacity of the DB instance, for example db.m4.large. @@ -41392,11 +41278,12 @@ type ModifyDBInstanceInput struct { // Default: Uses existing setting DBInstanceClass *string `type:"string"` - // The DB instance identifier. This value is stored as a lowercase string. + // The identifier of DB instance to modify. This value is stored as a lowercase + // string. // // Constraints: // - // * Must match the identifier of an existing DBInstance. + // * Must match the identifier of an existing DB instance. // // DBInstanceIdentifier is a required field DBInstanceIdentifier *string `type:"string" required:"true"` @@ -41411,12 +41298,13 @@ type ModifyDBInstanceInput struct { // the newly associated DB parameter group, these changes are applied immediately // without a reboot. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. // // Default: Uses existing setting // - // Constraints: The DB parameter group must be in the same DB parameter group - // family as the DB instance. + // Constraints: + // + // * Must be in the same DB parameter group family as the DB instance. DBParameterGroupName *string `type:"string"` // The port number on which the database accepts connections. @@ -41427,57 +41315,39 @@ type ModifyDBInstanceInput struct { // 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. - // - // MySQL - // - // Default: 3306 - // - // Valid values: 1150-65535 - // - // MariaDB - // - // Default: 3306 - // - // Valid values: 1150-65535 - // - // PostgreSQL - // - // Default: 5432 + // This setting doesn't apply to RDS Custom DB instances. // - // Valid values: 1150-65535 + // Valid Values: 1150-65535 // - // Type: Integer + // Default: // - // Oracle + // * Amazon Aurora - 3306 // - // Default: 1521 + // * RDS for MariaDB - 3306 // - // Valid values: 1150-65535 + // * RDS for Microsoft SQL Server - 1433 // - // SQL Server + // * RDS for MySQL - 3306 // - // Default: 1433 + // * RDS for Oracle - 1521 // - // Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and - // 49152-49156. + // * RDS for PostgreSQL - 5432 // - // Amazon Aurora - // - // Default: 3306 + // Constraints: // - // Valid values: 1150-65535 + // * For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, + // 3343, 3389, 47001, or 49152-49156. DBPortNumber *int64 `type:"integer"` // 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. + // This setting doesn't apply to RDS Custom DB instances. // // Constraints: // - // * If supplied, must match existing DBSecurityGroups. + // * If supplied, must match existing DB security groups. DBSecurityGroups []*string `locationNameList:"DBSecurityGroupName" type:"list"` // The new DB subnet group for the DB instance. You can use this parameter to @@ -41489,17 +41359,19 @@ type ModifyDBInstanceInput struct { // 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. + // This parameter doesn't apply to RDS Custom DB instances. // - // Constraints: If supplied, must match the name of an existing DBSubnetGroup. + // Constraints: + // + // * If supplied, must match existing DB subnet group. // // Example: mydbsubnetgroup DBSubnetGroupName *string `type:"string"` - // A value that indicates whether the DB instance has deletion protection enabled. - // The database can't be deleted when deletion protection is enabled. By default, - // deletion protection isn't enabled. For more information, see Deleting a DB - // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // 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 + // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` // The Active Directory directory ID to move the DB instance to. Specify none @@ -41510,16 +41382,16 @@ type ModifyDBInstanceInput struct { // For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. Domain *string `type:"string"` // The name of the IAM role to use when making API calls to the Directory Service. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. DomainIAMRoleName *string `type:"string"` - // A value that indicates whether to enable a customer-owned IP address (CoIP) - // for an RDS on Outposts DB instance. + // 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 @@ -41534,9 +41406,9 @@ type ModifyDBInstanceInput struct { // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool `type:"boolean"` - // A value that indicates whether to enable mapping of Amazon Web Services Identity - // and Access Management (IAM) accounts to database accounts. By default, mapping - // isn't enabled. + // 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. @@ -41545,16 +41417,15 @@ type ModifyDBInstanceInput struct { // Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to enable Performance Insights for the DB - // instance. + // Specifies whether to enable Performance Insights for the DB instance. // // For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. EnablePerformanceInsights *bool `type:"boolean"` // The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate @@ -41593,12 +41464,12 @@ type ModifyDBInstanceInput struct { // 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 will update the DB instance - // to the default minor version if the current minor version is lower. For information + // 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 later than the version that + // 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 @@ -41626,23 +41497,35 @@ type ModifyDBInstanceInput struct { // modifying the instance, rebooting the instance, deleting the instance, creating // a read replica for the instance, and creating a DB snapshot of the instance. // - // Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied - // must be at least 10% greater than the current value. Values that are not - // at least 10% greater than the existing value are rounded up so that they - // are 10% greater than the current value. + // 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 Iops *int64 `type:"integer"` // The license model for the DB instance. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. // - // Valid values: license-included | bring-your-own-license | general-public-license + // 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 LicenseModel *string `type:"string"` - // A value that indicates whether to manage the master user password with Amazon - // Web Services Secrets Manager. + // 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, @@ -41651,8 +41534,8 @@ type ModifyDBInstanceInput struct { // 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, RDS deletes the secret and uses the new - // password for the master user specified by MasterUserPassword. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) @@ -41664,48 +41547,43 @@ type ModifyDBInstanceInput struct { // Manager if MasterUserPassword is specified. ManageMasterUserPassword *bool `type:"boolean"` - // The new password for the master user. The password can include any printable - // ASCII character except "/", """, or "@". + // 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. // - // This setting doesn't apply to RDS Custom. - // - // Amazon Aurora - // - // Not applicable. The password for the master user is managed by the DB cluster. - // For more information, see ModifyDBCluster. + // 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. // - // Default: Uses existing setting + // This setting doesn't apply to the following DB instances: // - // Constraints: Can't be specified if ManageMasterUserPassword is turned on. + // * Amazon Aurora (The password for the master user is managed by the DB + // cluster. For more information, see ModifyDBCluster.) // - // MariaDB + // * RDS Custom // - // Constraints: Must contain from 8 to 41 characters. + // Default: Uses existing setting // - // Microsoft SQL Server + // Constraints: // - // Constraints: Must contain from 8 to 128 characters. + // * Can't be specified if ManageMasterUserPassword is turned on. // - // MySQL + // * Can include any printable ASCII character except "/", """, or "@". // - // Constraints: Must contain from 8 to 41 characters. + // Length Constraints: // - // Oracle + // * RDS for MariaDB - Must contain from 8 to 41 characters. // - // Constraints: Must contain from 8 to 30 characters. + // * RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. // - // PostgreSQL + // * RDS for MySQL - Must contain from 8 to 41 characters. // - // Constraints: Must contain from 8 to 128 characters. + // * RDS for Oracle - Must contain from 8 to 30 characters. // - // 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. + // * RDS for PostgreSQL - Must contain from 8 to 128 characters. MasterUserPassword *string `type:"string"` // The Amazon Web Services KMS key identifier to encrypt a secret that is automatically @@ -41743,19 +41621,21 @@ type ModifyDBInstanceInput struct { // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. MaxAllocatedStorage *int64 `type:"integer"` // The interval, in seconds, between points when Enhanced Monitoring metrics - // are collected for the DB instance. To disable collecting Enhanced Monitoring - // metrics, specify 0, which is the default. + // 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. + // This setting doesn't apply to RDS Custom DB instances. // - // Valid Values: 0, 1, 5, 10, 15, 30, 60 + // Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 + // + // Default: 0 MonitoringInterval *int64 `type:"integer"` // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics @@ -41767,40 +41647,36 @@ type ModifyDBInstanceInput struct { // If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn // value. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. MonitoringRoleArn *string `type:"string"` - // A value that indicates 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. + // 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. + // This setting doesn't apply to RDS Custom DB instances. MultiAZ *bool `type:"boolean"` // The network type of the DB instance. // - // Valid values: - // - // * IPV4 - // - // * DUAL - // // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon RDS User Guide. + // + // Valid Values: IPV4 | DUAL NetworkType *string `type:"string"` - // The new DB instance identifier for the DB instance when renaming a DB instance. - // When you change the DB instance identifier, an instance reboot occurs immediately + // 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 Apply Immediately. This value is stored as a lowercase + // window if you disable ApplyImmediately. This value is stored as a lowercase // string. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. // // Constraints: // @@ -41813,8 +41689,7 @@ type ModifyDBInstanceInput struct { // Example: mydbinstance NewDBInstanceIdentifier *string `type:"string"` - // A value that indicates the DB instance should be associated with the specified - // option group. + // 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 @@ -41828,7 +41703,7 @@ type ModifyDBInstanceInput struct { // 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. + // This setting doesn't apply to RDS Custom DB instances. OptionGroupName *string `type:"string"` // The Amazon Web Services KMS key identifier for encryption of Performance @@ -41837,37 +41712,31 @@ type ModifyDBInstanceInput struct { // The Amazon Web Services KMS key identifier is the key ARN, key ID, alias // ARN, or alias name for the KMS key. // - // If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon + // 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. + // This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *string `type:"string"` - // The number of days to retain Performance Insights data. The default is 7 - // days. The following values are valid: - // - // * 7 - // - // * month * 31, where month is a number of months from 1-23 - // - // * 731 + // The number of days to retain Performance Insights data. // - // For example, the following values are valid: + // This setting doesn't apply to RDS Custom DB instances. // - // * 93 (3 months * 31) + // Valid Values: // - // * 341 (11 months * 31) + // * 7 // - // * 589 (19 months * 31) + // * 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 // - // If you specify a retention period such as 94, which isn't a valid value, - // RDS issues an error. + // Default: 7 days // - // This setting doesn't apply to RDS Custom. + // If you specify a retention period that isn't valid, such as 94, Amazon RDS + // returns an error. PerformanceInsightsRetentionPeriod *int64 `type:"integer"` // The daily time range during which automated backups are created if automated @@ -41878,28 +41747,27 @@ type ModifyDBInstanceInput struct { // For more information, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) // in the Amazon RDS User Guide. // - // Amazon Aurora - // - // Not applicable. The daily time range for creating automated backups is managed - // by the DB cluster. For more information, see ModifyDBCluster. + // 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 the format hh24:mi-hh24:mi. // - // * Must be in Universal Time Coordinated (UTC) + // * Must be in Universal Coordinated Time (UTC). // - // * Must not conflict with the preferred maintenance window + // * Must not conflict with the preferred maintenance window. // - // * Must be at least 30 minutes + // * Must be at least 30 minutes. PreferredBackupWindow *string `type:"string"` - // The weekly time range (in UTC) during which system maintenance can occur, - // which might result in an outage. Changing this parameter doesn't result in - // an outage, except in the following situation, and the change is asynchronously - // applied as soon as possible. If there are pending actions that cause a reboot, - // and the maintenance window is changed to include the current time, then changing - // this parameter will cause a reboot of the DB instance. If moving this window + // 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. // @@ -41908,32 +41776,38 @@ type ModifyDBInstanceInput struct { // // Default: Uses existing setting // - // Format: ddd:hh24:mi-ddd:hh24:mi + // Constraints: + // + // * Must be in the format ddd:hh24:mi-ddd:hh24:mi. // - // Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun + // * The day values must be mon | tue | wed | thu | fri | sat | sun. // - // Constraints: Must be at least 30 minutes + // * Must be in Universal Coordinated Time (UTC). + // + // * Must not conflict with the preferred backup window. + // + // * Must be at least 30 minutes. PreferredMaintenanceWindow *string `type:"string"` // 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. + // This setting doesn't apply to RDS Custom DB instances. ProcessorFeatures []*ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that specifies the order in which an Aurora Replica is promoted to - // the primary instance after a failure of the existing primary instance. For - // more information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) // in the Amazon Aurora User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. // // Default: 1 // // Valid Values: 0 - 15 PromotionTier *int64 `type:"integer"` - // A value that indicates whether the DB instance is publicly accessible. + // 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 @@ -41966,16 +41840,23 @@ type ModifyDBInstanceInput struct { // Read Replicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) // in the Amazon RDS User Guide. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. ReplicaMode *string `type:"string" enum:"ReplicaMode"` // The number of minutes to pause the automation. When the time period ends, - // RDS Custom resumes full automation. The minimum value is 60 (default). The - // maximum value is 1,440. + // RDS Custom resumes full automation. + // + // Default: 60 + // + // Constraints: + // + // * Must be at least 60. + // + // * Must be no more than 1,440. ResumeFullAutomationModeMinutes *int64 `type:"integer"` - // A value that indicates whether to rotate the secret managed by Amazon Web - // Services Secrets Manager for the master user password. + // 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 @@ -41991,14 +41872,14 @@ type ModifyDBInstanceInput struct { // password. RotateMasterUserPassword *bool `type:"boolean"` - // Specifies the storage throughput value for the DB instance. + // The storage throughput value for the DB instance. // // This setting applies only to the gp3 storage type. // - // This setting doesn't apply to RDS Custom or Amazon Aurora. + // This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. StorageThroughput *int64 `type:"integer"` - // Specifies the storage type to be associated with the DB instance. + // 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. @@ -42016,41 +41897,41 @@ type ModifyDBInstanceInput struct { // 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 + // Valid Values: gp2 | gp3 | io1 | standard // - // Default: io1 if the Iops parameter is specified, otherwise gp2 + // Default: io1, if the Iops parameter is specified. Otherwise, gp2. StorageType *string `type:"string"` // The ARN from the key store with which to associate the instance for TDE encryption. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. TdeCredentialArn *string `type:"string"` // The password for the given ARN from the key store in order to access the // device. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. TdeCredentialPassword *string `type:"string"` - // A value that indicates whether the DB instance class of the DB instance uses - // its default processor features. + // Specifies whether the DB instance class of the DB instance uses its default + // processor features. // - // This setting doesn't apply to RDS Custom. + // This setting doesn't apply to RDS Custom DB instances. UseDefaultProcessorFeatures *bool `type:"boolean"` - // A list of Amazon EC2 VPC security groups to authorize on this DB instance. + // 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 RDS Custom. + // This setting doesn't apply to the following DB instances: // - // Amazon Aurora + // * Amazon Aurora (The associated list of EC2 VPC security groups is managed + // by the DB cluster. For more information, see ModifyDBCluster.) // - // Not applicable. 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 VpcSecurityGroupIds. + // * If supplied, must match existing VPC security group IDs. VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"` } @@ -43054,6 +42935,10 @@ type ModifyDBSnapshotInput struct { // // 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) @@ -51373,8 +51258,8 @@ func (s *ScalingConfiguration) SetTimeoutAction(v string) *ScalingConfiguration return s } -// Shows the scaling configuration for an Aurora DB cluster in serverless DB -// engine mode. +// The scaling configuration for an Aurora DB cluster in serverless DB engine +// mode. // // For more information, see Using Amazon Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) // in the Amazon Aurora User Guide. @@ -51517,7 +51402,7 @@ func (s *ServerlessV2ScalingConfiguration) SetMinCapacity(v float64) *Serverless return s } -// Shows the scaling configuration for an Aurora Serverless v2 DB cluster. +// The scaling configuration for an Aurora Serverless v2 DB cluster. // // For more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) // in the Amazon Aurora User Guide. diff --git a/service/verifiedpermissions/api.go b/service/verifiedpermissions/api.go index 802d06cd714..f34b3a89674 100644 --- a/service/verifiedpermissions/api.go +++ b/service/verifiedpermissions/api.go @@ -375,6 +375,9 @@ func (c *VerifiedPermissions) CreatePolicyStoreRequest(input *CreatePolicyStoreI // // Creates a policy store. A policy store is a container for policy resources. // +// Although Cedar supports multiple namespaces (https://docs.cedarpolicy.com/schema.html#namespace), +// Verified Permissions currently supports only one namespace per policy store. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -3909,7 +3912,7 @@ func (s *AttributeValue) SetString_(v string) *AttributeValue { // This data type is used as a field that is part of an Configuration (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html) // structure that is used as a parameter to the Configuration (https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html). // -// Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": +// Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"]} type CognitoUserPoolConfiguration struct { _ struct{} `type:"structure"` @@ -3923,7 +3926,7 @@ type CognitoUserPoolConfiguration struct { // The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the Amazon Cognito user pool that contains the identities to be authorized. // - // Example: "UserPoolArn": "cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5" + // Example: "UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5" // // UserPoolArn is a required field UserPoolArn *string `locationName:"userPoolArn" min:"1" type:"string" required:"true"` @@ -3993,7 +3996,7 @@ type Configuration struct { // It specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of a Amazon Cognito user pool and one or more application client IDs. // - // Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": + // Example: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"]}} CognitoUserPoolConfiguration *CognitoUserPoolConfiguration `locationName:"cognitoUserPoolConfiguration" type:"structure"` } @@ -6666,8 +6669,11 @@ type IsAuthorizedInput struct { // decisions. Context *ContextDefinition `locationName:"context" type:"structure"` - // Specifies the list of entities and their associated attributes that Verified - // Permissions can examine when evaluating the policies. + // Specifies the list of resources and principals and their associated attributes + // that Verified Permissions can examine when evaluating the policies. + // + // You can include only principal and resource entities in this parameter; you + // can't include actions. You must specify actions in the schema. Entities *EntitiesDefinition `locationName:"entities" type:"structure"` // Specifies the ID of the policy store. Policies in this policy store will @@ -6858,8 +6864,11 @@ type IsAuthorizedWithTokenInput struct { // decisions. Context *ContextDefinition `locationName:"context" type:"structure"` - // Specifies the list of entities and their associated attributes that Verified - // Permissions can examine when evaluating the policies. + // Specifies the list of resources and principals and their associated attributes + // that Verified Permissions can examine when evaluating the policies. + // + // You can include only principal and resource entities in this parameter; you + // can't include actions. You must specify actions in the schema. Entities *EntitiesDefinition `locationName:"entities" type:"structure"` // Specifies an identity token for the principal to be authorized. This token diff --git a/service/verifiedpermissions/doc.go b/service/verifiedpermissions/doc.go index ddf0446baae..4bfc370362f 100644 --- a/service/verifiedpermissions/doc.go +++ b/service/verifiedpermissions/doc.go @@ -52,12 +52,12 @@ // make sense for the same parameter in a different operation. To help you understand // the purpose of each, the following naming convention is used for the structures: // -// - Parameters that end in Detail are used in Get operations. +// - Parameter type structures that end in Detail are used in Get operations. // -// - Parameters that end in Item are used in List operations. +// - Parameter type structures that end in Item are used in List operations. // -// - Parameters that use neither suffix are used in the mutating (create -// and update) operations. +// - Parameter type structures that use neither suffix are used in the mutating +// (create and update) operations. // // See https://docs.aws.amazon.com/goto/WebAPI/verifiedpermissions-2021-12-01 for more information on this service. //