From e9e10db1d1a59634753183ee55a6cdbc4ae31a64 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Fri, 23 Jun 2023 18:13:32 +0000 Subject: [PATCH] Regenerated Clients --- .../58bcdb3ac45041ca8c1958dcf0f7e91d.json | 8 + .../62d82bd5f2a745b084f8596b1cfc918f.json | 8 + .../8762fde02fbe4ba2a046c3d3b06d28f2.json | 8 + .../feb0de0549af427b955a871d4246a4f4.json | 8 + .../api_op_AddNotificationChannel.go | 20 +- service/devopsguru/deserializers.go | 63 ++ service/devopsguru/serializers.go | 29 + service/devopsguru/types/enums.go | 18 + service/devopsguru/types/types.go | 121 ++-- service/fsx/types/types.go | 32 +- service/rds/api_op_CreateDBCluster.go | 343 +++++----- service/rds/api_op_CreateDBInstance.go | 596 +++++++++--------- service/rds/api_op_DescribeDBClusters.go | 16 +- service/rds/api_op_DescribeDBInstances.go | 14 +- service/rds/api_op_ModifyDBCluster.go | 325 +++++----- service/rds/api_op_ModifyDBInstance.go | 521 +++++++-------- service/rds/api_op_ModifyDBSnapshot.go | 2 + service/rds/types/types.go | 382 ++++++----- .../api_op_CreatePolicyStore.go | 2 + .../api_op_IsAuthorized.go | 6 +- .../api_op_IsAuthorizedWithToken.go | 6 +- service/verifiedpermissions/doc.go | 8 +- service/verifiedpermissions/types/types.go | 6 +- 23 files changed, 1380 insertions(+), 1162 deletions(-) create mode 100644 .changelog/58bcdb3ac45041ca8c1958dcf0f7e91d.json create mode 100644 .changelog/62d82bd5f2a745b084f8596b1cfc918f.json create mode 100644 .changelog/8762fde02fbe4ba2a046c3d3b06d28f2.json create mode 100644 .changelog/feb0de0549af427b955a871d4246a4f4.json diff --git a/.changelog/58bcdb3ac45041ca8c1958dcf0f7e91d.json b/.changelog/58bcdb3ac45041ca8c1958dcf0f7e91d.json new file mode 100644 index 00000000000..077b281c4ef --- /dev/null +++ b/.changelog/58bcdb3ac45041ca8c1958dcf0f7e91d.json @@ -0,0 +1,8 @@ +{ + "id": "58bcdb3a-c450-41ca-8c19-58dcf0f7e91d", + "type": "documentation", + "description": "Added improved descriptions and new code samples to SDK documentation.", + "modules": [ + "service/verifiedpermissions" + ] +} \ No newline at end of file diff --git a/.changelog/62d82bd5f2a745b084f8596b1cfc918f.json b/.changelog/62d82bd5f2a745b084f8596b1cfc918f.json new file mode 100644 index 00000000000..cd0ddc2ad3b --- /dev/null +++ b/.changelog/62d82bd5f2a745b084f8596b1cfc918f.json @@ -0,0 +1,8 @@ +{ + "id": "62d82bd5-f2a7-45b0-84f8-596b1cfc918f", + "type": "documentation", + "description": "Documentation improvements for create, describe, and modify DB clusters and DB instances.", + "modules": [ + "service/rds" + ] +} \ No newline at end of file diff --git a/.changelog/8762fde02fbe4ba2a046c3d3b06d28f2.json b/.changelog/8762fde02fbe4ba2a046c3d3b06d28f2.json new file mode 100644 index 00000000000..4648602fee8 --- /dev/null +++ b/.changelog/8762fde02fbe4ba2a046c3d3b06d28f2.json @@ -0,0 +1,8 @@ +{ + "id": "8762fde0-2fbe-4ba2-a046-c3d3b06d28f2", + "type": "feature", + "description": "This release adds support for encryption via customer managed keys.", + "modules": [ + "service/devopsguru" + ] +} \ No newline at end of file diff --git a/.changelog/feb0de0549af427b955a871d4246a4f4.json b/.changelog/feb0de0549af427b955a871d4246a4f4.json new file mode 100644 index 00000000000..8ca1e345c23 --- /dev/null +++ b/.changelog/feb0de0549af427b955a871d4246a4f4.json @@ -0,0 +1,8 @@ +{ + "id": "feb0de05-49af-427b-955a-871d4246a4f4", + "type": "documentation", + "description": "Update to Amazon FSx documentation.", + "modules": [ + "service/fsx" + ] +} \ No newline at end of file diff --git a/service/devopsguru/api_op_AddNotificationChannel.go b/service/devopsguru/api_op_AddNotificationChannel.go index 42d6cf4c0f8..bfd5a589d4e 100644 --- a/service/devopsguru/api_op_AddNotificationChannel.go +++ b/service/devopsguru/api_op_AddNotificationChannel.go @@ -14,18 +14,14 @@ import ( // 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 (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. 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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) +// 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 (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 to +// the CMK. For more information, see Permissions for Amazon Web Services +// KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) // . func (c *Client) AddNotificationChannel(ctx context.Context, params *AddNotificationChannelInput, optFns ...func(*Options)) (*AddNotificationChannelOutput, error) { if params == nil { diff --git a/service/devopsguru/deserializers.go b/service/devopsguru/deserializers.go index 3d91bec94b6..789d20c9b7c 100644 --- a/service/devopsguru/deserializers.go +++ b/service/devopsguru/deserializers.go @@ -7123,6 +7123,64 @@ func awsRestjson1_deserializeDocumentInternalServerException(v **types.InternalS return nil } +func awsRestjson1_deserializeDocumentKMSServerSideEncryptionIntegration(v **types.KMSServerSideEncryptionIntegration, value interface{}) error { + if v == nil { + return fmt.Errorf("unexpected nil of type %T", v) + } + if value == nil { + return nil + } + + shape, ok := value.(map[string]interface{}) + if !ok { + return fmt.Errorf("unexpected JSON type %v", value) + } + + var sv *types.KMSServerSideEncryptionIntegration + if *v == nil { + sv = &types.KMSServerSideEncryptionIntegration{} + } else { + sv = *v + } + + for key, value := range shape { + switch key { + case "KMSKeyId": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected KMSKeyId to be of type string, got %T instead", value) + } + sv.KMSKeyId = ptr.String(jtv) + } + + case "OptInStatus": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected OptInStatus to be of type string, got %T instead", value) + } + sv.OptInStatus = types.OptInStatus(jtv) + } + + case "Type": + if value != nil { + jtv, ok := value.(string) + if !ok { + return fmt.Errorf("expected ServerSideEncryptionType to be of type string, got %T instead", value) + } + sv.Type = types.ServerSideEncryptionType(jtv) + } + + default: + _, _ = key, value + + } + } + *v = sv + return nil +} + func awsRestjson1_deserializeDocumentLogAnomalyClass(v **types.LogAnomalyClass, value interface{}) error { if v == nil { return fmt.Errorf("unexpected nil of type %T", v) @@ -10673,6 +10731,11 @@ func awsRestjson1_deserializeDocumentServiceIntegrationConfig(v **types.ServiceI for key, value := range shape { switch key { + case "KMSServerSideEncryption": + if err := awsRestjson1_deserializeDocumentKMSServerSideEncryptionIntegration(&sv.KMSServerSideEncryption, value); err != nil { + return err + } + case "LogsAnomalyDetection": if err := awsRestjson1_deserializeDocumentLogsAnomalyDetectionIntegration(&sv.LogsAnomalyDetection, value); err != nil { return err diff --git a/service/devopsguru/serializers.go b/service/devopsguru/serializers.go index dec39cd8a12..777351a055d 100644 --- a/service/devopsguru/serializers.go +++ b/service/devopsguru/serializers.go @@ -2439,6 +2439,28 @@ func awsRestjson1_serializeDocumentInsightStatuses(v []types.InsightStatus, valu return nil } +func awsRestjson1_serializeDocumentKMSServerSideEncryptionIntegrationConfig(v *types.KMSServerSideEncryptionIntegrationConfig, value smithyjson.Value) error { + object := value.Object() + defer object.Close() + + if v.KMSKeyId != nil { + ok := object.Key("KMSKeyId") + ok.String(*v.KMSKeyId) + } + + if len(v.OptInStatus) > 0 { + ok := object.Key("OptInStatus") + ok.String(string(v.OptInStatus)) + } + + if len(v.Type) > 0 { + ok := object.Key("Type") + ok.String(string(v.Type)) + } + + return nil +} + func awsRestjson1_serializeDocumentListAnomaliesForInsightFilters(v *types.ListAnomaliesForInsightFilters, value smithyjson.Value) error { object := value.Object() defer object.Close() @@ -2993,6 +3015,13 @@ func awsRestjson1_serializeDocumentUpdateServiceIntegrationConfig(v *types.Updat object := value.Object() defer object.Close() + if v.KMSServerSideEncryption != nil { + ok := object.Key("KMSServerSideEncryption") + if err := awsRestjson1_serializeDocumentKMSServerSideEncryptionIntegrationConfig(v.KMSServerSideEncryption, ok); err != nil { + return err + } + } + if v.LogsAnomalyDetection != nil { ok := object.Key("LogsAnomalyDetection") if err := awsRestjson1_serializeDocumentLogsAnomalyDetectionIntegrationConfig(v.LogsAnomalyDetection, ok); err != nil { diff --git a/service/devopsguru/types/enums.go b/service/devopsguru/types/enums.go index 86b383d2b29..777e7ed37f1 100644 --- a/service/devopsguru/types/enums.go +++ b/service/devopsguru/types/enums.go @@ -523,6 +523,24 @@ func (ResourceTypeFilter) Values() []ResourceTypeFilter { } } +type ServerSideEncryptionType string + +// Enum values for ServerSideEncryptionType +const ( + ServerSideEncryptionTypeCustomerManagedKey ServerSideEncryptionType = "CUSTOMER_MANAGED_KEY" + ServerSideEncryptionTypeAwsOwnedKmsKey ServerSideEncryptionType = "AWS_OWNED_KMS_KEY" +) + +// Values returns all known values for ServerSideEncryptionType. Note that this +// can be expanded in the future, and so it is only as up to date as the client. +// The ordering of this slice is not guaranteed to be stable across updates. +func (ServerSideEncryptionType) Values() []ServerSideEncryptionType { + return []ServerSideEncryptionType{ + "CUSTOMER_MANAGED_KEY", + "AWS_OWNED_KMS_KEY", + } +} + type ServiceName string // Enum values for ServiceName diff --git a/service/devopsguru/types/types.go b/service/devopsguru/types/types.go index 475adcce7b1..32147ae44b0 100644 --- a/service/devopsguru/types/types.go +++ b/service/devopsguru/types/types.go @@ -468,6 +468,59 @@ type InsightTimeRange struct { noSmithyDocumentSerde } +// Information about the KMS encryption used with DevOps Guru. +type KMSServerSideEncryptionIntegration struct { + + // 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 + + // Specifies if DevOps Guru is enabled for customer managed keys. + OptInStatus 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 ServerSideEncryptionType + + noSmithyDocumentSerde +} + +// Information about whether DevOps Guru is configured to encrypt server-side data +// using KMS. +type KMSServerSideEncryptionIntegrationConfig struct { + + // 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 + + // Specifies if DevOps Guru is enabled for KMS integration. + OptInStatus 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 ServerSideEncryptionType + + noSmithyDocumentSerde +} + // Specifies one or more service names that are used to list anomalies. type ListAnomaliesForInsightFilters struct { @@ -680,18 +733,14 @@ type MonitoredResourceIdentifier struct { // 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 (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. 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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) +// 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 to +// the CMK. For more information, see Permissions for Amazon Web Services +// KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) // . type NotificationChannel struct { @@ -713,18 +762,14 @@ type NotificationChannelConfig struct { // 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 (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. 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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) + // 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 to + // the CMK. For more information, see Permissions for Amazon Web Services + // KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) // . // // This member is required. @@ -1841,6 +1886,10 @@ type ServiceInsightHealth struct { // Services service, such as Amazon Web Services Systems Manager. type ServiceIntegrationConfig struct { + // Information about whether DevOps Guru is configured to encrypt server-side data + // using KMS. + KMSServerSideEncryption *KMSServerSideEncryptionIntegration + // Information about whether DevOps Guru is configured to perform log anomaly // detection on Amazon CloudWatch log groups. LogsAnomalyDetection *LogsAnomalyDetectionIntegration @@ -1885,18 +1934,14 @@ type ServiceResourceCost struct { // 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 (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. 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 (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) +// 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 (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 to +// the CMK. For more information, see Permissions for Amazon Web Services +// KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html) // . type SnsChannelConfig struct { @@ -2146,6 +2191,10 @@ type UpdateResourceCollectionFilter struct { // service, such as Amazon Web Services Systems Manager, with DevOps Guru. type UpdateServiceIntegrationConfig struct { + // Information about whether DevOps Guru is configured to encrypt server-side data + // using KMS. + KMSServerSideEncryption *KMSServerSideEncryptionIntegrationConfig + // Information about whether DevOps Guru is configured to perform log anomaly // detection on Amazon CloudWatch log groups. LogsAnomalyDetection *LogsAnomalyDetectionIntegrationConfig diff --git a/service/fsx/types/types.go b/service/fsx/types/types.go index 2b5f47cef6b..0f4ab79efb1 100644 --- a/service/fsx/types/types.go +++ b/service/fsx/types/types.go @@ -538,7 +538,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 . + // days. The default is 30 . AutomaticBackupRetentionDays *int32 // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the @@ -591,9 +591,9 @@ type CreateFileSystemOpenZFSConfiguration struct { // 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). + // 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 in the US + // 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 (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions) @@ -617,7 +617,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 . + // days. The default is 30 . AutomaticBackupRetentionDays *int32 // A Boolean value indicating whether tags for the file system should be copied to @@ -706,9 +706,9 @@ type CreateFileSystemWindowsConfiguration struct { // File Server file system. AuditLogConfiguration *WindowsAuditLogCreateConfiguration - // 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 *int32 // A boolean flag indicating whether tags for the file system should be copied to @@ -1977,7 +1977,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 . + // days. The default is 30 . AutomaticBackupRetentionDays *int32 // A boolean flag indicating whether tags on the file system are copied to @@ -2186,7 +2186,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 . + // days. The default is 30 . AutomaticBackupRetentionDays *int32 // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the @@ -2412,7 +2412,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 . + // days. The default is 30 . AutomaticBackupRetentionDays *int32 // A Boolean value indicating whether tags on the file system should be copied to @@ -3063,7 +3063,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 . + // days. The default is 30 . AutomaticBackupRetentionDays *int32 // A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the @@ -3115,7 +3115,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 . + // days. The default is 30 . AutomaticBackupRetentionDays *int32 // A Boolean value indicating whether tags for the file system should be copied to @@ -3177,10 +3177,10 @@ type UpdateFileSystemWindowsConfiguration struct { // File Server file system.. AuditLogConfiguration *WindowsAuditLogCreateConfiguration - // 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 (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups) + // 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 *int32 diff --git a/service/rds/api_op_CreateDBCluster.go b/service/rds/api_op_CreateDBCluster.go index fbf0c4afc90..9e75f474e8e 100644 --- a/service/rds/api_op_CreateDBCluster.go +++ b/service/rds/api_op_CreateDBCluster.go @@ -44,153 +44,153 @@ func (c *Client) CreateDBCluster(ctx context.Context, params *CreateDBClusterInp type CreateDBClusterInput struct { - // 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: // - 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 + // Example: my-cluster1 // // This member is required. DBClusterIdentifier *string - // 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 + // 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 // // This member is required. Engine *string // 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 + // Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only This + // setting is required to create a Multi-AZ DB cluster. AllocatedStorage *int32 - // 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 + // 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 AutoMinorVersionUpgrade *bool // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only AvailabilityZones []string // The target backtrack window, in seconds. To disable backtracking, set this - // value to 0. Default: 0 Constraints: + // 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 - // 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 + // 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. BackupRetentionPeriod *int32 - // A value that indicates that the DB cluster should be associated with the - // specified CharacterSet. Valid for: Aurora DB clusters only + // The name of the character set ( CharacterSet ) to associate the DB cluster with. + // Valid for Cluster Type: Aurora DB clusters only CharacterSetName *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. Valid for: Aurora - // DB clusters and Multi-AZ DB clusters + // 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 CopyTagsToSnapshot *bool // 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB - // cluster. Valid for: Multi-AZ DB clusters only + // cluster. Valid for Cluster Type: Multi-AZ DB clusters only DBClusterInstanceClass *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 for - // the specified DB engine and version is used. Constraints: + // 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 // 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 + // 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 DBSubnetGroupName *string // Reserved for future use. DBSystemId *string - // The name for your database of up to 64 alphanumeric characters. If you do not + // 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 + // creating. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters DatabaseName *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. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // 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 DeletionProtection *bool // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only Domain *string - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. Valid for: Aurora DB clusters only + // The name of the IAM role to use when making API calls to the Directory Service. + // Valid for Cluster Type: Aurora DB clusters only DomainIAMRoleName *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. 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. 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 + // in the Amazon Aurora User Guide. EnableCloudwatchLogsExports []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. 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 + // 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 EnableGlobalWriteForwarding *bool - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) + // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only EnableHttpEndpoint *bool - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // 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 Cluster Type: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool - // A value that indicates 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 + // 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 Cluster Type: Multi-AZ DB clusters only EnablePerformanceInsights *bool // The DB engine mode of the DB cluster, either provisioned or serverless . The @@ -199,7 +199,7 @@ type CreateDBClusterInput struct { // the following sections in the Amazon Aurora User Guide: // - Limitations of Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) // - 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 // The version number of the database engine to use. To list all of the available @@ -216,27 +216,31 @@ type CreateDBClusterInput struct { // "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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) - // in the Amazon Aurora User Guide. 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 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. PostgreSQL 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. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // "DBEngineVersions[].EngineVersion" For information about a specific engine, see + // the following topics: + // - 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. + // - 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. + // - 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. + // - 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters EngineVersion *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 + // the new global database cluster. Valid for Cluster Type: Aurora DB clusters only GlobalClusterIdentifier *string // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) // 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 + // 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. Iops *int32 // The Amazon Web Services KMS key identifier for an encrypted DB cluster. The @@ -245,35 +249,35 @@ type CreateDBClusterInput struct { // 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. + // 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 + // 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: Aurora DB clusters and Multi-AZ DB clusters + // Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters KmsKeyId *string - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // 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) // in the Amazon RDS User Guide and Password management with Amazon Web Services // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) - // in the Amazon Aurora User Guide. Constraints: + // 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 - // The password for the master database user. This password can contain any - // printable ASCII character except "/", """, or "@". Constraints: + // 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. - // Valid for: Aurora DB clusters and Multi-AZ DB clusters MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is @@ -288,21 +292,21 @@ type CreateDBClusterInput struct { // 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 + // Region. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *string - // The name of the master user for the DB cluster. Constraints: + // 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. - // Valid for: Aurora DB clusters and Multi-AZ DB clusters MasterUsername *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. 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 + // 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 MonitoringInterval *int32 // The Amazon Resource Name (ARN) for the IAM role that permits RDS to send @@ -310,22 +314,20 @@ type CreateDBClusterInput struct { // arn:aws:iam:123456789012:role/emaccess . For information on creating a // monitoring role, see Setting up and enabling Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) // 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 + // than 0 , supply a MonitoringRoleArn value. Valid for Cluster Type: Multi-AZ DB + // clusters only MonitoringRoleArn *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 ). 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only + // Valid Values: IPV4 | DUAL NetworkType *string - // 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. + // 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 // The Amazon Web Services KMS key identifier for encryption of Performance @@ -334,27 +336,24 @@ type CreateDBClusterInput struct { // 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 + // Region. Valid for Cluster Type: Multi-AZ DB clusters only PerformanceInsightsKMSKeyId *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 for Cluster Type: + // Multi-AZ DB clusters only 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 - // 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 + // Default: 7 days If you specify a retention period that isn't valid, such as 94 , + // Amazon RDS issues an error. PerformanceInsightsRetentionPeriod *int32 // 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 + // 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 Port *int32 // When you are replicating a DB cluster from one Amazon Web Services GovCloud @@ -387,11 +386,12 @@ type CreateDBClusterInput struct { // 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 + // Valid for Cluster Type: Aurora DB clusters only PreSignedUrl *string // The daily time range during which automated backups are created if automated - // backups are enabled using the BackupRetentionPeriod parameter. The default is a + // 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) // in the Amazon Aurora User Guide. Constraints: @@ -399,30 +399,31 @@ type CreateDBClusterInput struct { // - 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 PreferredBackupWindow *string - // 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 + // 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 (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: Minimum 30-minute window. Valid for: Aurora DB clusters and - // Multi-AZ DB clusters + // 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. PreferredMaintenanceWindow *string - // 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: + // 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 @@ -433,16 +434,15 @@ type CreateDBClusterInput struct { // 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 PubliclyAccessible *bool // 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 + // DB cluster is created as a read replica. Valid for Cluster Type: Aurora DB + // clusters and Multi-AZ DB clusters ReplicationSourceIdentifier *string // For DB clusters in serverless DB engine mode, the scaling properties of the DB - // cluster. Valid for: Aurora DB clusters only + // cluster. Valid for Cluster Type: Aurora DB clusters only ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For @@ -454,28 +454,31 @@ type CreateDBClusterInput struct { // region, if the PresignURL member is empty set. SourceRegion *string - // A value that indicates whether the DB cluster is encrypted. Valid for: Aurora + // Specifies whether the DB cluster is encrypted. Valid for Cluster Type: Aurora // DB clusters and Multi-AZ DB clusters StorageEncrypted *bool - // 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 (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) - // . + // 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 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 StorageType *string - // Tags to assign to the DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters + // and Multi-AZ DB clusters Tags []types.Tag - // A list of EC2 VPC security groups to associate with this DB cluster. Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // 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 VpcSecurityGroupIds []string // Used by the SDK's PresignURL autofill customization to specify the region the diff --git a/service/rds/api_op_CreateDBInstance.go b/service/rds/api_op_CreateDBInstance.go index 2bc3235043c..dad910b2fa7 100644 --- a/service/rds/api_op_CreateDBInstance.go +++ b/service/rds/api_op_CreateDBInstance.go @@ -36,7 +36,7 @@ func (c *Client) CreateDBInstance(ctx context.Context, params *CreateDBInstanceI type CreateDBInstanceInput struct { - // The compute and memory capacity of the DB instance, for example db.m5.large. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) @@ -46,8 +46,8 @@ type CreateDBInstanceInput struct { // This member is required. DBInstanceClass *string - // The DB instance identifier. This parameter is stored as a lowercase string. - // Constraints: + // 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. @@ -56,9 +56,8 @@ type CreateDBInstanceInput struct { // This member is required. DBInstanceIdentifier *string - // 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: - // + // 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) @@ -81,41 +80,38 @@ type CreateDBInstanceInput struct { // This member is required. Engine *string - // 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: + // The amount of storage in gibibytes (GiB) to allocate for the DB instance. This + // setting doesn't apply to Amazon Aurora DB instances. Aurora cluster volumes + // automatically grow as the amount of data in your database increases, though you + // are only charged for the space that you use in an Aurora cluster volume. Amazon + // RDS Custom RDS for MariaDB RDS for MySQL RDS for Oracle RDS for PostgreSQL RDS + // for SQL Server Constraints to the amount of storage for each storage type are + // the following: // - General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to // 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server. // - Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS // Custom for Oracle, 16384 for RDS Custom for SQL Server. - // MySQL Constraints to the amount of storage for each storage type are the - // following: + // 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: + // 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: + // 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: + // - 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 10 to 3072. - // SQL Server Constraints to the amount of storage for each storage type are the - // following: + // - 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. @@ -127,65 +123,70 @@ type CreateDBInstanceInput struct { // - Web and Express editions: Must be an integer from 20 to 1024. AllocatedStorage *int32 - // 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 . + // 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 . AutoMinorVersionUpgrade *bool // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) - // . Amazon Aurora Each Aurora DB cluster hosts copies of its storage in three + // . 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 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. + // 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 AvailabilityZone *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. 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 + // 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. BackupRetentionPeriod *int32 - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) // in the Amazon RDS User Guide. BackupTarget *string - // 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. CACertificateIdentifier *string - // 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 . + // 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. CharacterSetName *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 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. + // 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. CopyTagsToSnapshot *bool // The instance profile associated with the underlying Amazon EC2 instance of an - // RDS Custom DB instance. The instance profile must meet the following - // requirements: + // 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. @@ -193,69 +194,67 @@ type CreateDBInstanceInput struct { // the prefix AWSRDSCustom . // 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. + // in the Amazon RDS User Guide. CustomIamInstanceProfile *string - // The identifier of the DB cluster that the instance will belong to. This setting - // doesn't apply to RDS Custom. + // The identifier of the DB cluster that this DB instance will belong to. This + // setting doesn't apply to RDS Custom DB instances. DBClusterIdentifier *string - // 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. + // The meaning of this parameter differs depending on the database engine. Amazon + // Aurora MySQL Amazon Aurora PostgreSQL Amazon RDS Custom for Oracle Amazon RDS + // Custom for SQL Server RDS for MariaDB RDS for MySQL RDS for Oracle RDS for + // PostgreSQL RDS for SQL Server The name of the database to create when the + // primary DB instance of the Aurora MySQL DB cluster is created. If you don't + // specify a value, Amazon RDS doesn't create a database in the DB cluster. + // Constraints: + // - Must contain 1 to 64 alphanumeric characters. + // - Can't be a word reserved by the database engine. + // The name of the database to create when the primary DB instance of the Aurora + // PostgreSQL DB cluster is created. Default: postgres Constraints: + // - Must contain 1 to 63 alphanumeric characters. + // - Must begin with a letter. Subsequent characters can be letters, + // underscores, or digits (0 to 9). + // - Can't be a word reserved by the database engine. + // The Oracle System ID (SID) of the created RDS Custom DB instance. Default: ORCL // Constraints: + // - Must contain 1 to 8 alphanumeric characters. + // - Must contain a letter. + // - Can't be a word reserved by the database engine. + // Not applicable. Must be null. The name of the database to create when the DB + // instance is created. If you don't specify a value, Amazon RDS doesn't create a + // database in the DB instance. Constraints: // - Must contain 1 to 64 letters or numbers. // - Must begin with a letter. Subsequent characters can be letters, // underscores, or digits (0-9). - // - Can't be a word reserved by the 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. + // - 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 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: + // - 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 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. + // - Can't be a word reserved by the database engine. + // Not applicable. Must be null. DBName *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. This setting doesn't apply to RDS Custom. - // Constraints: - // - It must be 1 to 255 letters, numbers, or hyphens. + // 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. - // - 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 // A list of DB security groups to associate with this DB instance. This setting @@ -263,50 +262,55 @@ type CreateDBInstanceInput struct { // new DB instances. Use the VpcSecurityGroupIds setting instead. DBSecurityGroups []string - // 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 + // 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 DBSubnetGroupName *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) - // . 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. + // 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) + // . 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 // 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 + // 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. Amazon - // Aurora Not applicable. The domain is managed by the DB cluster. + // 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 Domain *string - // 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. + // 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 DomainIAMRoleName *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) - // 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 . + // 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. 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 EnableCloudwatchLogsExports []string - // 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) // in the Amazon RDS User Guide. For more information about CoIPs, see @@ -314,93 +318,103 @@ type CreateDBInstanceInput struct { // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool - // 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 (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. Amazon - // Aurora Not applicable. Mapping Amazon Web Services IAM accounts to database - // accounts is managed by the DB cluster. + // 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 the following DB + // instances: + // - Amazon Aurora (Mapping Amazon Web Services IAM accounts to database + // accounts is managed by the DB cluster.) + // - RDS Custom EnableIAMDatabaseAuthentication *bool - // 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. + // 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 DB + // instances. EnablePerformanceInsights *bool - // 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 (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) - // 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) - // 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) - // 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) - // 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) + // The version number of the database engine to use. This setting doesn't apply to + // Amazon Aurora DB instances. The version number of the database engine the DB + // instance uses is managed by the DB cluster. For a list of valid engine versions, + // use the DescribeDBEngineVersions operation. The following are the database + // engines and links to information about the major and minor versions that are + // available with Amazon RDS. Not every database engine is available for every + // Amazon Web Services Region. Amazon RDS Custom for Oracle Amazon RDS Custom for + // SQL Server RDS for MariaDB RDS for Microsoft SQL Server RDS for MySQL RDS for + // Oracle RDS for PostgreSQL A custom engine version (CEV) that you have previously + // created. This setting is required for RDS Custom for Oracle. The CEV name has + // the following format: 19.customized_string. A valid CEV name is 19.my_cev1 . For + // more information, see Creating an RDS Custom for Oracle DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create) + // in the Amazon RDS User Guide. 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. 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. 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. 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. 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. 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 - // 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) - // 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. + // 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. 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. Iops *int32 // 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. + // 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. KmsKeyId *string - // 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. + // 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 LicenseModel *string - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // 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) // in the Amazon RDS User Guide. Constraints: // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. ManageMasterUserPassword *bool - // 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. + // 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. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is @@ -418,9 +432,9 @@ type CreateDBInstanceInput struct { // Region. MasterUserSecretKmsKeyId *string - // 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. + // 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. @@ -430,15 +444,17 @@ type CreateDBInstanceInput struct { // 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 (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. Amazon - // Aurora Not applicable. Storage is managed by the DB cluster. + // 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 MaxAllocatedStorage *int32 // 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 + // 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 MonitoringInterval *int32 // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics @@ -446,114 +462,116 @@ type CreateDBInstanceInput struct { // For information on creating a monitoring role, see Setting Up and Enabling // Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) // 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. + // than 0 , then you must supply a MonitoringRoleArn value. This setting doesn't + // apply to RDS Custom DB instances. MonitoringRoleArn *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. This setting doesn't apply to RDS Custom. Amazon Aurora Not - // applicable. DB instance Availability Zones (AZs) are managed by the DB cluster. + // 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 MultiAZ *bool - // The name of the NCHAR character set for the Oracle DB instance. This parameter - // doesn't apply to RDS Custom. + // The name of the NCHAR character set for the Oracle DB instance. This setting + // doesn't apply to RDS Custom DB instances. NcharCharacterSetName *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. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // in the Amazon RDS User Guide. Valid Values: IPV4 | DUAL NetworkType *string - // 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. + // 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. OptionGroupName *string // 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 + // 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. + // Region. This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *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. 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 - // - 731 - // For example, the following values are valid: - // - 93 (3 months * 31) - // - 341 (11 months * 31) - // - 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. This setting doesn't apply to RDS Custom. + // Default: 7 days If you specify a retention period that isn't valid, such as 94 , + // Amazon RDS returns an error. PerformanceInsightsRetentionPeriod *int32 - // 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 + // 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 . Port *int32 // 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 (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. Constraints: + // 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. PreferredBackupWindow *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 default is a 30-minute window selected at + // 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: Minimum 30-minute window. + // 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. PreferredMaintenanceWindow *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. + // class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS + // Custom DB instances. ProcessorFeatures []types.ProcessorFeature - // 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) - // in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. - // Default: 1 Valid Values: 0 - 15 + // 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 DB + // instances. Default: 1 Valid Values: 0 - 15 PromotionTier *int32 - // 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: + // 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 @@ -566,35 +584,35 @@ type CreateDBInstanceInput struct { // it, the DB instance is public. PubliclyAccessible *bool - // 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. + // 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. StorageEncrypted *bool - // 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. + // 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. StorageThroughput *int32 - // 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. + // 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 . StorageType *string // Tags to assign to the DB instance. Tags []types.Tag // 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. + // encryption. This setting doesn't apply to Amazon Aurora or RDS Custom DB + // instances. TdeCredentialArn *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. + // device. This setting doesn't apply to RDS Custom DB instances. TdeCredentialPassword *string // The time zone of the DB instance. The time zone parameter is currently @@ -603,9 +621,9 @@ type CreateDBInstanceInput struct { Timezone *string // 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. + // 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 noSmithyDocumentSerde diff --git a/service/rds/api_op_DescribeDBClusters.go b/service/rds/api_op_DescribeDBClusters.go index 71f9f483e6b..95a88578d3f 100644 --- a/service/rds/api_op_DescribeDBClusters.go +++ b/service/rds/api_op_DescribeDBClusters.go @@ -18,9 +18,9 @@ import ( "time" ) -// 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? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) +// 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) // in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, // see Multi-AZ DB cluster deployments (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) // in the Amazon RDS User Guide. This operation can also return information for @@ -43,13 +43,13 @@ func (c *Client) DescribeDBClusters(ctx context.Context, params *DescribeDBClust type DescribeDBClustersInput struct { // 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 + // 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 - // A filter that specifies one or more DB clusters to describe. Supported filters: + // 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 @@ -64,8 +64,8 @@ type DescribeDBClustersInput struct { // about the DB clusters for these engines. Filters []types.Filter - // 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 // An optional pagination token provided by a previous DescribeDBClusters request. diff --git a/service/rds/api_op_DescribeDBInstances.go b/service/rds/api_op_DescribeDBInstances.go index 21b883147d3..60f4b1871a6 100644 --- a/service/rds/api_op_DescribeDBInstances.go +++ b/service/rds/api_op_DescribeDBInstances.go @@ -19,9 +19,9 @@ import ( "time" ) -// 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. func (c *Client) DescribeDBInstances(ctx context.Context, params *DescribeDBInstancesInput, optFns ...func(*Options)) (*DescribeDBInstancesOutput, error) { if params == nil { params = &DescribeDBInstancesInput{} @@ -42,11 +42,11 @@ type DescribeDBInstancesInput struct { // 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. + // - If supplied, must match the identifier of an existing DB instance. DBInstanceIdentifier *string // A filter that specifies one or more DB instances to describe. Supported - // filters: + // 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. @@ -54,8 +54,8 @@ type DescribeDBInstancesInput struct { // 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. + // 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 diff --git a/service/rds/api_op_ModifyDBCluster.go b/service/rds/api_op_ModifyDBCluster.go index 29c3b226819..b48acdc2af0 100644 --- a/service/rds/api_op_ModifyDBCluster.go +++ b/service/rds/api_op_ModifyDBCluster.go @@ -11,7 +11,7 @@ import ( smithyhttp "github.com/aws/smithy-go/transport/http" ) -// 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. For more information on Amazon Aurora DB clusters, see // What is Amazon Aurora? (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html) @@ -36,151 +36,155 @@ func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInp type ModifyDBClusterInput struct { // 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 + // case-sensitive. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB + // clusters Constraints: + // - Must match the identifier of an existing DB cluster. // // This member is required. DBClusterIdentifier *string // 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 + // Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only AllocatedStorage *int32 - // 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 + // 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. AllowEngineModeChange bool - // 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 + // 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. AllowMajorVersionUpgrade bool - // 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 + // 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: Aurora DB clusters and Multi-AZ DB clusters + // for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters ApplyImmediately bool - // 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 + // 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 AutoMinorVersionUpgrade *bool // The target backtrack window, in seconds. To disable backtracking, set this - // value to 0. Default: 0 Constraints: + // 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 // 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 + // 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. BackupRetentionPeriod *int32 // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) // in the Amazon RDS User Guide. 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 + // in the Amazon Aurora User Guide. CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration - // 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 + // 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 CopyTagsToSnapshot *bool // 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) - // in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only + // in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only DBClusterInstanceClass *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 + // 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 DBClusterParameterGroupName *string // 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: + // 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. - // Valid for: Aurora DB clusters only DBInstanceParameterGroupName *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. Valid for: Aurora DB clusters and Multi-AZ DB - // clusters + // 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 DeletionProtection *bool // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only Domain *string - // Specify the name of the IAM role to be used when making API calls to the - // Directory Service. Valid for: Aurora DB clusters only + // The name of the IAM role to use when making API calls to the Directory Service. + // Valid for Cluster Type: Aurora DB clusters only DomainIAMRoleName *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. 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 + // 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 EnableGlobalWriteForwarding *bool - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) + // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only EnableHttpEndpoint *bool - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) - // in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only + // 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 Cluster Type: Aurora DB clusters only EnableIAMDatabaseAuthentication *bool - // A value that indicates 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 + // 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 Cluster Type: Multi-AZ DB clusters only EnablePerformanceInsights *bool // 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 (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 // The version number of the database engine to which you want to upgrade. @@ -199,38 +203,40 @@ type ModifyDBClusterInput struct { // "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 + // "DBEngineVersions[].EngineVersion" Valid for Cluster Type: Aurora DB clusters + // and Multi-AZ DB clusters EngineVersion *string // 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 (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: Multi-AZ DB clusters only + // 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. Iops *int32 - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide and Password management with Amazon Web Services // 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 + // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and + // Multi-AZ DB clusters ManageMasterUserPassword *bool - // The new password for the master database user. This password can contain any - // printable ASCII character except "/", """, or "@". Constraints: + // 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. - // Valid for: Aurora DB clusters and Multi-AZ DB clusters MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is @@ -251,15 +257,15 @@ type ModifyDBClusterInput struct { // 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 + // different default KMS key for each Amazon Web Services Region. Valid for Cluster + // Type: Aurora DB clusters and Multi-AZ DB clusters MasterUserSecretKmsKeyId *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. 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 + // 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 MonitoringInterval *int32 // The Amazon Resource Name (ARN) for the IAM role that permits RDS to send @@ -267,30 +273,29 @@ type ModifyDBClusterInput struct { // arn:aws:iam:123456789012:role/emaccess . For information on creating a // monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) // 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 + // than 0 , supply a MonitoringRoleArn value. Valid for Cluster Type: Multi-AZ DB + // clusters only MonitoringRoleArn *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 ). 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only + // Valid Values: IPV4 | DUAL NetworkType *string // 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 + // 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 NewDBClusterIdentifier *string - // 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. + // 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 // The Amazon Web Services KMS key identifier for encryption of Performance @@ -299,67 +304,65 @@ type ModifyDBClusterInput struct { // 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 + // Region. Valid for Cluster Type: Multi-AZ DB clusters only PerformanceInsightsKMSKeyId *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 for Cluster Type: + // Multi-AZ DB clusters only Valid Values: // - 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) + // - 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. Valid for: Multi-AZ DB clusters only + // Default: 7 days If you specify a retention period that isn't valid, such as 94 , + // Amazon RDS issues an error. PerformanceInsightsRetentionPeriod *int32 - // 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 + // 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. Port *int32 // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) - // in the Amazon Aurora User Guide. Constraints: + // 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. - // Valid for: Aurora DB clusters and Multi-AZ DB clusters PreferredBackupWindow *string // 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 (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: Minimum 30-minute window. Valid for: Aurora DB clusters and - // Multi-AZ DB clusters + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) + // 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. PreferredMaintenanceWindow *string - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide and Password management with Amazon Web Services // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) - // in the Amazon Aurora User Guide. Constraints: + // 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 // 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 + // properties for DB clusters in serverless DB engine mode. Valid for Cluster + // Type: Aurora DB clusters only ScalingConfiguration *types.ScalingConfiguration // Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For @@ -367,15 +370,23 @@ type ModifyDBClusterInput struct { // in the Amazon Aurora User Guide. ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration - // 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 + // 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 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 StorageType *string - // A list of VPC security groups that the DB cluster will belong to. Valid for: - // Aurora DB clusters and Multi-AZ DB clusters + // 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 VpcSecurityGroupIds []string noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyDBInstance.go b/service/rds/api_op_ModifyDBInstance.go index 0a6746bd239..c8dc9a6dcd9 100644 --- a/service/rds/api_op_ModifyDBInstance.go +++ b/service/rds/api_op_ModifyDBInstance.go @@ -32,32 +32,32 @@ func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceI type ModifyDBInstanceInput struct { - // The DB instance identifier. This value is stored as a lowercase string. - // Constraints: - // - Must match the identifier of an existing DBInstance. + // 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. // // This member is required. DBInstanceIdentifier *string // 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 . + // 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 *int32 - // 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. + // 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. AllowMajorVersionUpgrade bool - // 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 + // 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 @@ -67,25 +67,24 @@ type ModifyDBInstanceInput struct { // are applied. ApplyImmediately bool - // 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. // - 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. + // 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. AutoMinorVersionUpgrade *bool - // 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 types.AutomationMode // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services - // Backup. This setting doesn't apply to RDS Custom. + // Backup. This setting doesn't apply to RDS Custom DB instances. AwsBackupRecoveryPointArn *string // The number of days to retain automated backups. Setting this parameter to a @@ -95,61 +94,56 @@ type ModifyDBInstanceInput struct { // 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. + // 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. BackupRetentionPeriod *int32 - // 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) // in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB // cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) // in the Amazon Aurora User Guide. CACertificateIdentifier *string - // 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: + // 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. (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) // 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 (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 - // 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. + // 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. CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration - // 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 . + // 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 . CopyTagsToSnapshot *bool - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) // in the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) // in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support // for RDS Custom for Oracle (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits.html#custom-reqs-limits.instances) @@ -166,27 +160,33 @@ type ModifyDBInstanceInput struct { // 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. + // 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. DBParameterGroupName *string // 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 + // 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 . DBPortNumber *int32 // 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. + // soon as possible. This setting doesn't apply to RDS Custom DB instances. + // Constraints: + // - If supplied, must match existing DB security groups. DBSecurityGroups []string // The new DB subnet group for the DB instance. You can use this parameter to move @@ -195,15 +195,15 @@ type ModifyDBInstanceInput struct { // information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC) // 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. + // enable ApplyImmediately . This parameter doesn't apply to RDS Custom DB + // instances. Constraints: + // - If supplied, must match existing DB subnet group. // Example: mydbsubnetgroup DBSubnetGroupName *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 @@ -212,18 +212,19 @@ type ModifyDBInstanceInput struct { // 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 (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. + // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB + // instances. Domain *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 - // 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) // in the Amazon RDS User Guide. For more information about CoIPs, see @@ -231,18 +232,20 @@ type ModifyDBInstanceInput struct { // in the Amazon Web Services Outposts User Guide. EnableCustomerOwnedIp *bool - // 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 (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. + // 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 (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 DB + // instances. EnableIAMDatabaseAuthentication *bool - // 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) - // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. + // 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 DB + // instances. EnablePerformanceInsights *bool // The target Oracle DB engine when you convert a non-CDB to a CDB. This @@ -270,11 +273,11 @@ type ModifyDBInstanceInput struct { // 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 + // 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 the source DB instance + // 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. EngineVersion *string @@ -296,49 +299,58 @@ type ModifyDBInstanceInput struct { // 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 + // 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 Iops *int32 - // 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 + // 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 LicenseModel *string - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide. Constraints: // - Can't manage the master user password with Amazon Web Services Secrets // Manager if MasterUserPassword is specified. ManageMasterUserPassword *bool - // 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 + // 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 . 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. + // 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. MasterUserPassword *string // The Amazon Web Services KMS key identifier to encrypt a secret that is @@ -366,14 +378,15 @@ type ModifyDBInstanceInput struct { // 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 (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. + // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB + // instances. MaxAllocatedStorage *int32 // 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 + // 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 MonitoringInterval *int32 // The ARN for the IAM role that permits RDS to send enhanced monitoring metrics @@ -381,70 +394,63 @@ type ModifyDBInstanceInput struct { // For information on creating a monitoring role, see To create an IAM role for // Amazon RDS Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole) // 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. + // than 0 , supply a MonitoringRoleArn value. This setting doesn't apply to RDS + // Custom DB instances. MonitoringRoleArn *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. This setting doesn't apply to RDS Custom. + // 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. MultiAZ *bool - // 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. + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // in the Amazon RDS User Guide. Valid Values: IPV4 | DUAL NetworkType *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 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: + // 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 NewDBInstanceIdentifier *string - // 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. + // 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. OptionGroupName *string // 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 + // 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. + // Region. This setting doesn't apply to RDS Custom DB instances. PerformanceInsightsKMSKeyId *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. 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 - // - 731 - // For example, the following values are valid: - // - 93 (3 months * 31) - // - 341 (11 months * 31) - // - 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. This setting doesn't apply to RDS Custom. + // Default: 7 days If you specify a retention period that isn't valid, such as 94 , + // Amazon RDS returns an error. PerformanceInsightsRetentionPeriod *int32 // The daily time range during which automated backups are created if automated @@ -453,53 +459,55 @@ type ModifyDBInstanceInput struct { // 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 (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 . 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 + // 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. PreferredBackupWindow *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 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) - // 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 + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) + // 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. PreferredMaintenanceWindow *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. + // class of the DB instance. This setting doesn't apply to RDS Custom DB instances. ProcessorFeatures []types.ProcessorFeature - // 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) - // in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. - // Default: 1 Valid Values: 0 - 15 + // 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 DB + // instances. Default: 1 Valid Values: 0 - 15 PromotionTier *int32 - // 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. + // 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. PubliclyAccessible *bool // A value that sets the open mode of a replica database to either mounted or @@ -510,66 +518,69 @@ type ModifyDBInstanceInput struct { // 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 (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. + // in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB + // instances. ReplicaMode types.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 . + // Custom resumes full automation. Default: 60 Constraints: + // - Must be at least 60. + // - Must be no more than 1,440. ResumeFullAutomationModeMinutes *int32 - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) // in the Amazon RDS User Guide. Constraints: // - You must apply the change immediately when rotating the master user // password. RotateMasterUserPassword *bool - // 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. + // 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. StorageThroughput *int32 - // 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 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 . StorageType *string // The ARN from the key store with which to associate the instance for TDE - // encryption. This setting doesn't apply to RDS Custom. + // encryption. This setting doesn't apply to RDS Custom DB instances. TdeCredentialArn *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. + // device. This setting doesn't apply to RDS Custom DB instances. TdeCredentialPassword *string - // 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. + // 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. UseDefaultProcessorFeatures *bool - // 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 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. VpcSecurityGroupIds []string noSmithyDocumentSerde diff --git a/service/rds/api_op_ModifyDBSnapshot.go b/service/rds/api_op_ModifyDBSnapshot.go index 64682c1d452..d0109c0705f 100644 --- a/service/rds/api_op_ModifyDBSnapshot.go +++ b/service/rds/api_op_ModifyDBSnapshot.go @@ -42,6 +42,8 @@ type ModifyDBSnapshotInput struct { // 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) diff --git a/service/rds/types/types.go b/service/rds/types/types.go index 0ed35c10b57..e2eda565ad3 100644 --- a/service/rds/types/types.go +++ b/service/rds/types/types.go @@ -454,31 +454,31 @@ type DBCluster struct { // automatically adjusts as needed. AllocatedStorage *int32 - // 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 - // A value that indicates that minor version patches are applied automatically. - // This setting is only for non-Aurora Multi-AZ DB clusters. + // Indicates whether minor version patches are applied automatically. This setting + // is only for non-Aurora Multi-AZ DB clusters. AutoMinorVersionUpgrade bool // The time when a stopped DB cluster is restarted automatically. AutomaticRestartTime *time.Time - // 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 // The number of change records stored for Backtrack. BacktrackConsumedChangeRecords *int64 - // The target backtrack window, in seconds. If this value is set to 0, + // The target backtrack window, in seconds. If this value is set to 0 , // backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled. BacktrackWindow *int64 - // Specifies the number of days for which automatic DB snapshots are retained. + // The number of days for which automatic DB snapshots are retained. BackupRetentionPeriod *int32 // The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 @@ -491,28 +491,27 @@ type DBCluster struct { // associated with. CharacterSetName *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 - // 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 - // Specifies whether tags are copied from the DB cluster to snapshots of the DB + // Indicates whether tags are copied from the DB cluster to snapshots of the DB // cluster. CopyTagsToSnapshot *bool - // Specifies whether the DB cluster is a clone of a DB cluster owned by a + // Indicates whether the DB cluster is a clone of a DB cluster owned by a // different Amazon Web Services account. CrossAccountClone *bool - // Identifies all custom endpoints associated with the cluster. + // The custom endpoints associated with the DB cluster. CustomEndpoints []string // The Amazon Resource Name (ARN) for the DB cluster. DBClusterArn *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 @@ -520,25 +519,25 @@ type DBCluster struct { // setting is only for non-Aurora Multi-AZ DB clusters. DBClusterInstanceClass *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 - // Provides the list of option group memberships for this DB cluster. + // The list of option group memberships for this DB cluster. DBClusterOptionGroupMemberships []DBClusterOptionGroupStatus - // 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 - // 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 // Reserved for future use. DBSystemId *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 // The Amazon Web Services Region-unique, immutable identifier for the DB cluster. @@ -546,8 +545,8 @@ type DBCluster struct { // the KMS key for the DB cluster is accessed. DbClusterResourceId *string - // Indicates if the DB cluster has deletion protection enabled. The database can't - // be deleted when deletion protection is enabled. + // Indicates whether the DB cluster has deletion protection enabled. The database + // can't be deleted when deletion protection is enabled. DeletionProtection *bool // The Active Directory Domain membership records associated with the DB cluster. @@ -566,10 +565,10 @@ type DBCluster struct { // in the Amazon Aurora User Guide. EnabledCloudwatchLogsExports []string - // 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 - // The name of the database engine to be used for this DB cluster. + // The database engine used for this DB cluster. Engine *string // The DB engine mode of the DB cluster, either provisioned or serverless . For @@ -577,33 +576,32 @@ type DBCluster struct { // . EngineMode *string - // Indicates the database engine version. + // The version of the database engine. EngineVersion *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 - // 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 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 - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) // in the Amazon Aurora User Guide. HttpEndpointEnabled *bool - // 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 // The next time you can modify the DB cluster to use the aurora-iopt1 storage @@ -619,19 +617,18 @@ type DBCluster struct { // ARN, key ID, alias ARN, or alias name for the KMS key. KmsKeyId *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 - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // 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 and Password management with Amazon Web Services // Secrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) // in the Amazon Aurora User Guide. MasterUserSecret *MasterUserSecret - // Contains the master username for the DB cluster. + // The master username for the DB cluster. MasterUsername *string // The interval, in seconds, between points when Enhanced Monitoring metrics are @@ -644,29 +641,27 @@ type DBCluster struct { // clusters. MonitoringRoleArn *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 - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) + // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) // in the Amazon Aurora User Guide. This setting is only for Aurora DB clusters. + // Valid Values: IPV4 | DUAL NetworkType *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 by + // 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 - // Specifies the progress of the operation as a percentage. + // The progress of the operation as a percentage. PercentProgress *string - // True if Performance Insights is enabled for the DB cluster, and otherwise - // false. This setting is only for non-Aurora Multi-AZ DB clusters. + // Indicates whether Performance Insights is enabled for the DB cluster. This + // setting is only for non-Aurora Multi-AZ DB clusters. PerformanceInsightsEnabled *bool // The Amazon Web Services KMS key identifier for encryption of Performance @@ -675,39 +670,35 @@ type DBCluster struct { // non-Aurora Multi-AZ DB clusters. PerformanceInsightsKMSKeyId *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. 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 - // - 731 - // For example, the following values are valid: - // - 93 (3 months * 31) - // - 341 (11 months * 31) - // - 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 *int32 - // Specifies the port that the database engine is listening on. + // The port that the database engine is listening on. Port *int32 - // 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 - // 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 - // 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 + // 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. PubliclyAccessible *bool @@ -726,24 +717,23 @@ type DBCluster struct { // cluster, you can then reconnect to the reader endpoint. ReaderEndpoint *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 - // Shows 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) + // 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 - // Shows 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) + // 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 - // Specifies the current state of this DB cluster. + // The current state of this DB cluster. Status *string - // Specifies whether the DB cluster is encrypted. + // Indicates whether the DB cluster is encrypted. StorageEncrypted bool // The storage type associated with the DB cluster. @@ -753,7 +743,7 @@ type DBCluster struct { // in the Amazon RDS User Guide. TagList []Tag - // 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 noSmithyDocumentSerde @@ -1224,14 +1214,14 @@ type DBInstance struct { // The status of the database activity stream. ActivityStreamStatus ActivityStreamStatus - // Specifies the allocated storage size specified in gibibytes (GiB). + // The amount of storage in gibibytes (GiB) allocated for the DB instance. AllocatedStorage int32 // The Amazon Web Services Identity and Access Management (IAM) roles associated // with the DB instance. AssociatedRoles []DBInstanceRole - // A value that indicates that minor version patches are applied automatically. + // Indicates whether minor version patches are applied automatically. AutoMinorVersionUpgrade bool // The time when a stopped DB instance is restarted automatically. @@ -1243,18 +1233,18 @@ type DBInstance struct { // --resume-full-automation-mode-minutes . AutomationMode 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 // The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services // Backup. AwsBackupRecoveryPointArn *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 int32 - // Specifies where automated backups and manual snapshots are stored: Amazon Web - // Services Outposts or the Amazon Web Services Region. + // The location where automated backups and manual snapshots are stored: Amazon + // Web Services Outposts or the Amazon Web Services Region. BackupTarget *string // The identifier of the CA certificate for this DB instance. For more @@ -1271,10 +1261,11 @@ type DBInstance struct { // associated with. CharacterSetName *string - // 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 . + // 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 . CopyTagsToSnapshot bool // The instance profile associated with the underlying Amazon EC2 instance of an @@ -1290,7 +1281,7 @@ type DBInstance struct { // in the Amazon RDS User Guide. CustomIamInstanceProfile *string - // Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on + // 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 @@ -1302,7 +1293,7 @@ type DBInstance struct { // in the Amazon Web Services Outposts User Guide. CustomerOwnedIpEnabled *bool - // If the DB instance is a member of a DB cluster, contains the name of the DB + // 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 @@ -1312,44 +1303,44 @@ type DBInstance struct { // The list of replicated automated backups associated with the DB instance. DBInstanceAutomatedBackupsReplications []DBInstanceAutomatedBackupsReplication - // 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 - // 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 - // Specifies 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) + // 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 - // 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. + // 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. DBName *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 // A list of DB security group elements containing DBSecurityGroup.Name and // DBSecurityGroup.Status subelements. DBSecurityGroups []DBSecurityGroupMembership - // 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 // 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 - // 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 int32 // The Amazon Web Services Region-unique, immutable identifier for the DB @@ -1357,7 +1348,7 @@ type DBInstance struct { // whenever the Amazon Web Services KMS key for the DB instance is accessed. DbiResourceId *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) // . @@ -1368,61 +1359,61 @@ type DBInstance struct { // 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 (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 - // Specifies the connection endpoint. The endpoint might not be shown for - // instances whose status is creating . + // The connection endpoint for the DB instance. The endpoint might not be shown + // for instances with the status of creating . Endpoint *Endpoint - // The name of the database engine to be used for this DB instance. + // The database engine used for this DB instance. Engine *string - // Indicates the database engine version. + // The version of the database engine. EngineVersion *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 - // 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 + // 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) // in the Amazon RDS User Guide and IAM database authentication in Aurora (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.IAMdbauth.html) // in the Amazon Aurora User Guide. IAMDatabaseAuthenticationEnabled bool - // Provides the date and time the DB instance was created. + // The date and time when the DB instance was created. InstanceCreateTime *time.Time - // Specifies the Provisioned IOPS (I/O operations per second) value. + // The Provisioned IOPS (I/O operations per second) value for the DB instance. Iops *int32 - // 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 + // 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 - // Specifies the latest time to which a database can be restored with + // The latest time to which a database in this DB instance can be restored with // point-in-time restore. LatestRestorableTime *time.Time - // 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 - // Specifies the listener connection endpoint for SQL Server Always On. + // The listener connection endpoint for SQL Server Always On. ListenerEndpoint *Endpoint - // 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 (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) + // 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 - // Contains the master username for the DB instance. + // The master username for the DB instance. MasterUsername *string // The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale @@ -1437,8 +1428,8 @@ type DBInstance struct { // to Amazon CloudWatch Logs. MonitoringRoleArn *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 // The name of the NCHAR character set for the Oracle DB instance. This character @@ -1446,27 +1437,23 @@ type DBInstance struct { // NCHAR, NCLOB, or NVARCHAR2. NcharCharacterSetName *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) + // 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 (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. + // in the Amazon Aurora User Guide. Valid Values: IPV4 | DUAL NetworkType *string - // Provides the list of option group memberships for this DB instance. + // The list of option group memberships for this DB instance. OptionGroupMemberships []OptionGroupMembership - // 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. + // 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 - // 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 // The Amazon Web Services KMS key identifier for encryption of Performance @@ -1474,38 +1461,34 @@ type DBInstance struct { // ID, alias ARN, or alias name for the KMS key. PerformanceInsightsKMSKeyId *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 - // - 731 - // For example, the following values are valid: - // - 93 (3 months * 31) - // - 341 (11 months * 31) - // - 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 + // Default: 7 days PerformanceInsightsRetentionPeriod *int32 - // 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 - // 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 // The number of CPU cores and the number of threads per core for the DB instance // class of the DB instance. ProcessorFeatures []ProcessorFeature - // 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 *int32 - // Specifies the accessibility options for the DB instance. When the DB cluster is - // publicly accessible, its Domain Name System (DNS) endpoint resolves to the + // 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 @@ -1515,24 +1498,21 @@ type DBInstance struct { // more information, see CreateDBInstance . PubliclyAccessible bool - // 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 + // 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 - // 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 - // 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 - // 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 // The open mode of an Oracle read replica. The default is open-read-only . For @@ -1550,18 +1530,18 @@ type DBInstance struct { // instance with multi-AZ support. SecondaryAvailabilityZone *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 - // Specifies whether the DB instance is encrypted. + // Indicates whether the DB instance is encrypted. StorageEncrypted bool - // 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. StorageThroughput *int32 - // Specifies the storage type associated with the DB instance. + // The storage type associated with the DB instance. StorageType *string // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) @@ -1577,7 +1557,7 @@ type DBInstance struct { // created with a time zone specified. Timezone *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 noSmithyDocumentSerde @@ -3511,8 +3491,8 @@ type ScalingConfiguration struct { noSmithyDocumentSerde } -// Shows 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) +// 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. type ScalingConfigurationInfo struct { @@ -3567,8 +3547,8 @@ type ServerlessV2ScalingConfiguration struct { noSmithyDocumentSerde } -// Shows 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) +// 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. type ServerlessV2ScalingConfigurationInfo struct { diff --git a/service/verifiedpermissions/api_op_CreatePolicyStore.go b/service/verifiedpermissions/api_op_CreatePolicyStore.go index b10161bc37b..d022e83ed71 100644 --- a/service/verifiedpermissions/api_op_CreatePolicyStore.go +++ b/service/verifiedpermissions/api_op_CreatePolicyStore.go @@ -14,6 +14,8 @@ import ( ) // 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. func (c *Client) CreatePolicyStore(ctx context.Context, params *CreatePolicyStoreInput, optFns ...func(*Options)) (*CreatePolicyStoreOutput, error) { if params == nil { params = &CreatePolicyStoreInput{} diff --git a/service/verifiedpermissions/api_op_IsAuthorized.go b/service/verifiedpermissions/api_op_IsAuthorized.go index fbba38d7b42..1dc33da5d07 100644 --- a/service/verifiedpermissions/api_op_IsAuthorized.go +++ b/service/verifiedpermissions/api_op_IsAuthorized.go @@ -48,8 +48,10 @@ type IsAuthorizedInput struct { // authorization decisions. Context types.ContextDefinition - // 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 types.EntitiesDefinition // Specifies the principal for which the authorization decision is to be made. diff --git a/service/verifiedpermissions/api_op_IsAuthorizedWithToken.go b/service/verifiedpermissions/api_op_IsAuthorizedWithToken.go index a275a645254..c3dd812527d 100644 --- a/service/verifiedpermissions/api_op_IsAuthorizedWithToken.go +++ b/service/verifiedpermissions/api_op_IsAuthorizedWithToken.go @@ -57,8 +57,10 @@ type IsAuthorizedWithTokenInput struct { // authorization decisions. Context types.ContextDefinition - // 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 types.EntitiesDefinition // Specifies an identity token for the principal to be authorized. This token is diff --git a/service/verifiedpermissions/doc.go b/service/verifiedpermissions/doc.go index 6c6b3926d56..274015401de 100644 --- a/service/verifiedpermissions/doc.go +++ b/service/verifiedpermissions/doc.go @@ -44,8 +44,8 @@ // 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. +// - 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. package verifiedpermissions diff --git a/service/verifiedpermissions/types/types.go b/service/verifiedpermissions/types/types.go index d8b78103837..222be5eacdb 100644 --- a/service/verifiedpermissions/types/types.go +++ b/service/verifiedpermissions/types/types.go @@ -107,14 +107,14 @@ func (*AttributeValueMemberString) isAttributeValue() {} // 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": +// "CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"]} 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" + // "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5" // // This member is required. UserPoolArn *string @@ -143,7 +143,7 @@ type Configuration interface { // Permissions can use as a source of authenticated identities as entities. 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": +// "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": // ["a1b2c3d4e5f6g7h8i9j0kalbmc"]}} type ConfigurationMemberCognitoUserPoolConfiguration struct { Value CognitoUserPoolConfiguration