aws-sdk-rds 1.105.0 → 1.110.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -163,9 +163,9 @@ module Aws::RDS
163
163
  data[:preferred_maintenance_window]
164
164
  end
165
165
 
166
- # Specifies that changes to the DB instance are pending. This element is
167
- # only included when changes are pending. Specific changes are
168
- # identified by subelements.
166
+ # A value that specifies that changes to the DB instance are pending.
167
+ # This element is only included when changes are pending. Specific
168
+ # changes are identified by subelements.
169
169
  # @return [Types::PendingModifiedValues]
170
170
  def pending_modified_values
171
171
  data[:pending_modified_values]
@@ -190,7 +190,8 @@ module Aws::RDS
190
190
  data[:engine_version]
191
191
  end
192
192
 
193
- # Indicates that minor version patches are applied automatically.
193
+ # A value that indicates that minor version patches are applied
194
+ # automatically.
194
195
  # @return [Boolean]
195
196
  def auto_minor_version_upgrade
196
197
  data[:auto_minor_version_upgrade]
@@ -341,6 +342,9 @@ module Aws::RDS
341
342
 
342
343
  # If `StorageEncrypted` is true, the AWS KMS key identifier for the
343
344
  # encrypted DB instance.
345
+ #
346
+ # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
347
+ # name for the AWS KMS customer master key (CMK).
344
348
  # @return [String]
345
349
  def kms_key_id
346
350
  data[:kms_key_id]
@@ -348,7 +352,7 @@ module Aws::RDS
348
352
 
349
353
  # The AWS Region-unique, immutable identifier for the DB instance. This
350
354
  # identifier is found in AWS CloudTrail log entries whenever the AWS KMS
351
- # key for the DB instance is accessed.
355
+ # customer master key (CMK) for the DB instance is accessed.
352
356
  # @return [String]
353
357
  def dbi_resource_id
354
358
  data[:dbi_resource_id]
@@ -454,8 +458,10 @@ module Aws::RDS
454
458
  end
455
459
 
456
460
  # The AWS KMS key identifier for encryption of Performance Insights
457
- # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
458
- # identifier, or the KMS key alias for the KMS encryption key.
461
+ # data.
462
+ #
463
+ # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
464
+ # name for the AWS KMS customer master key (CMK).
459
465
  # @return [String]
460
466
  def performance_insights_kms_key_id
461
467
  data[:performance_insights_kms_key_id]
@@ -533,6 +539,37 @@ module Aws::RDS
533
539
  data[:tag_list]
534
540
  end
535
541
 
542
+ # The list of replicated automated backups associated with the DB
543
+ # instance.
544
+ # @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
545
+ def db_instance_automated_backups_replications
546
+ data[:db_instance_automated_backups_replications]
547
+ end
548
+
549
+ # Specifies whether a customer-owned IP address (CoIP) is enabled for an
550
+ # RDS on Outposts DB instance.
551
+ #
552
+ # A <i>CoIP </i>provides local or external connectivity to resources in
553
+ # your Outpost subnets through your on-premises network. For some use
554
+ # cases, a CoIP can provide lower latency for connections to the DB
555
+ # instance from outside of its virtual private cloud (VPC) on your local
556
+ # network.
557
+ #
558
+ # For more information about RDS on Outposts, see [Working with Amazon
559
+ # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
560
+ #
561
+ # For more information about CoIPs, see [Customer-owned IP addresses][2]
562
+ # in the *AWS Outposts User Guide*.
563
+ #
564
+ #
565
+ #
566
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
567
+ # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
568
+ # @return [Boolean]
569
+ def customer_owned_ip_enabled
570
+ data[:customer_owned_ip_enabled]
571
+ end
572
+
536
573
  # @!endgroup
537
574
 
538
575
  # @return [Client]
@@ -726,6 +763,7 @@ module Aws::RDS
726
763
  # ],
727
764
  # deletion_protection: false,
728
765
  # max_allocated_storage: 1,
766
+ # enable_customer_owned_ip: false,
729
767
  # })
730
768
  # @param [Hash] options ({})
731
769
  # @option options [String] :db_name
@@ -765,8 +803,8 @@ module Aws::RDS
765
803
  # **PostgreSQL**
766
804
  #
767
805
  # The name of the database to create when the DB instance is created. If
768
- # this parameter isn't specified, the default "postgres" database is
769
- # created in the DB instance.
806
+ # this parameter isn't specified, no database is created in the DB
807
+ # instance.
770
808
  #
771
809
  # Constraints:
772
810
  #
@@ -1064,8 +1102,8 @@ module Aws::RDS
1064
1102
  # specify the identifier of the custom Availability Zone to create the
1065
1103
  # DB instance in.
1066
1104
  #
1067
- # For more information about RDS on VMware, see the [ *RDS on VMware
1068
- # User Guide.* ][2]
1105
+ # For more information about RDS on VMware, see the [ RDS on VMware User
1106
+ # Guide.][2]
1069
1107
  #
1070
1108
  # </note>
1071
1109
  #
@@ -1241,8 +1279,8 @@ module Aws::RDS
1241
1279
  #
1242
1280
  # **PostgreSQL**
1243
1281
  #
1244
- # See [Supported PostgreSQL Database Versions][5] in the *Amazon RDS
1245
- # User Guide.*
1282
+ # See [Amazon RDS for PostgreSQL versions and extensions][5] in the
1283
+ # *Amazon RDS User Guide.*
1246
1284
  #
1247
1285
  #
1248
1286
  #
@@ -1250,7 +1288,7 @@ module Aws::RDS
1250
1288
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
1251
1289
  # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
1252
1290
  # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
1253
- # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions
1291
+ # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
1254
1292
  # @option options [Boolean] :auto_minor_version_upgrade
1255
1293
  # A value that indicates whether minor engine upgrades are applied
1256
1294
  # automatically to the DB instance during the maintenance window. By
@@ -1275,8 +1313,8 @@ module Aws::RDS
1275
1313
  #
1276
1314
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
1277
1315
  # @option options [String] :option_group_name
1278
- # Indicates that the DB instance should be associated with the specified
1279
- # option group.
1316
+ # A value that indicates that the DB instance should be associated with
1317
+ # the specified option group.
1280
1318
  #
1281
1319
  # Permanent options, such as the TDE option for Oracle Advanced Security
1282
1320
  # TDE, can't be removed from an option group. Also, that option group
@@ -1355,22 +1393,19 @@ module Aws::RDS
1355
1393
  # @option options [String] :kms_key_id
1356
1394
  # The AWS KMS key identifier for an encrypted DB instance.
1357
1395
  #
1358
- # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
1359
- # encryption key. If you are creating a DB instance with the same AWS
1360
- # account that owns the KMS encryption key used to encrypt the new DB
1361
- # instance, then you can use the KMS key alias instead of the ARN for
1362
- # the KM encryption key.
1396
+ # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
1397
+ # name for the AWS KMS customer master key (CMK). To use a CMK in a
1398
+ # different AWS account, specify the key ARN or alias ARN.
1363
1399
  #
1364
1400
  # **Amazon Aurora**
1365
1401
  #
1366
- # Not applicable. The KMS key identifier is managed by the DB cluster.
1367
- # For more information, see `CreateDBCluster`.
1402
+ # Not applicable. The AWS KMS key identifier is managed by the DB
1403
+ # cluster. For more information, see `CreateDBCluster`.
1368
1404
  #
1369
1405
  # If `StorageEncrypted` is enabled, and you do not specify a value for
1370
- # the `KmsKeyId` parameter, then Amazon RDS will use your default
1371
- # encryption key. AWS KMS creates the default encryption key for your
1372
- # AWS account. Your AWS account has a different default encryption key
1373
- # for each AWS Region.
1406
+ # the `KmsKeyId` parameter, then Amazon RDS uses your default CMK. There
1407
+ # is a default CMK for your AWS account. Your AWS account has a
1408
+ # different default CMK for each AWS Region.
1374
1409
  # @option options [String] :domain
1375
1410
  # The Active Directory directory ID to create the DB instance in.
1376
1411
  # Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
@@ -1462,13 +1497,15 @@ module Aws::RDS
1462
1497
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
1463
1498
  # @option options [String] :performance_insights_kms_key_id
1464
1499
  # The AWS KMS key identifier for encryption of Performance Insights
1465
- # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
1466
- # identifier, or the KMS key alias for the KMS encryption key.
1500
+ # data.
1501
+ #
1502
+ # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
1503
+ # name for the AWS KMS customer master key (CMK).
1467
1504
  #
1468
1505
  # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
1469
- # Amazon RDS uses your default encryption key. AWS KMS creates the
1470
- # default encryption key for your AWS account. Your AWS account has a
1471
- # different default encryption key for each AWS Region.
1506
+ # Amazon RDS uses your default CMK. There is a default CMK for your AWS
1507
+ # account. Your AWS account has a different default CMK for each AWS
1508
+ # Region.
1472
1509
  # @option options [Integer] :performance_insights_retention_period
1473
1510
  # The amount of time, in days, to retain Performance Insights data.
1474
1511
  # Valid values are 7 or 731 (2 years).
@@ -1497,7 +1534,8 @@ module Aws::RDS
1497
1534
  #
1498
1535
  # **Oracle**
1499
1536
  #
1500
- # Possible values are `alert`, `audit`, `listener`, and `trace`.
1537
+ # Possible values are `alert`, `audit`, `listener`, `trace`, and
1538
+ # `oemagent`.
1501
1539
  #
1502
1540
  # **PostgreSQL**
1503
1541
  #
@@ -1528,6 +1566,25 @@ module Aws::RDS
1528
1566
  # @option options [Integer] :max_allocated_storage
1529
1567
  # The upper limit to which Amazon RDS can automatically scale the
1530
1568
  # storage of the DB instance.
1569
+ # @option options [Boolean] :enable_customer_owned_ip
1570
+ # A value that indicates whether to enable a customer-owned IP address
1571
+ # (CoIP) for an RDS on Outposts DB instance.
1572
+ #
1573
+ # A *CoIP* provides local or external connectivity to resources in your
1574
+ # Outpost subnets through your on-premises network. For some use cases,
1575
+ # a CoIP can provide lower latency for connections to the DB instance
1576
+ # from outside of its virtual private cloud (VPC) on your local network.
1577
+ #
1578
+ # For more information about RDS on Outposts, see [Working with Amazon
1579
+ # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
1580
+ #
1581
+ # For more information about CoIPs, see [Customer-owned IP addresses][2]
1582
+ # in the *AWS Outposts User Guide*.
1583
+ #
1584
+ #
1585
+ #
1586
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
1587
+ # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
1531
1588
  # @return [DBInstance]
1532
1589
  def create(options = {})
1533
1590
  options = options.merge(db_instance_identifier: @id)
@@ -1747,20 +1804,21 @@ module Aws::RDS
1747
1804
  #
1748
1805
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
1749
1806
  # @option options [String] :kms_key_id
1750
- # The AWS KMS key ID for an encrypted read replica. The KMS key ID is
1751
- # the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
1752
- # alias for the KMS encryption key.
1807
+ # The AWS KMS key identifier for an encrypted read replica.
1808
+ #
1809
+ # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
1810
+ # name for the AWS KMS CMK.
1753
1811
  #
1754
1812
  # If you create an encrypted read replica in the same AWS Region as the
1755
- # source DB instance, then you do not have to specify a value for this
1756
- # parameter. The read replica is encrypted with the same KMS key as the
1757
- # source DB instance.
1813
+ # source DB instance, then do not specify a value for this parameter. A
1814
+ # read replica in the same Region is always encrypted with the same AWS
1815
+ # KMS CMK as the source DB instance.
1758
1816
  #
1759
1817
  # If you create an encrypted read replica in a different AWS Region,
1760
- # then you must specify a KMS key for the destination AWS Region. KMS
1761
- # encryption keys are specific to the AWS Region that they are created
1762
- # in, and you can't use encryption keys from one AWS Region in another
1763
- # AWS Region.
1818
+ # then you must specify a AWS KMS key identifier for the destination AWS
1819
+ # Region. AWS KMS CMKs are specific to the AWS Region that they are
1820
+ # created in, and you can't use CMKs from one AWS Region in another AWS
1821
+ # Region.
1764
1822
  #
1765
1823
  # You can't create an encrypted read replica from an unencrypted DB
1766
1824
  # instance.
@@ -1849,13 +1907,15 @@ module Aws::RDS
1849
1907
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
1850
1908
  # @option options [String] :performance_insights_kms_key_id
1851
1909
  # The AWS KMS key identifier for encryption of Performance Insights
1852
- # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
1853
- # identifier, or the KMS key alias for the KMS encryption key.
1910
+ # data.
1911
+ #
1912
+ # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
1913
+ # name for the AWS KMS customer master key (CMK).
1854
1914
  #
1855
1915
  # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
1856
- # Amazon RDS uses your default encryption key. AWS KMS creates the
1857
- # default encryption key for your AWS account. Your AWS account has a
1858
- # different default encryption key for each AWS Region.
1916
+ # Amazon RDS uses your default CMK. There is a default CMK for your AWS
1917
+ # account. Your AWS account has a different default CMK for each AWS
1918
+ # Region.
1859
1919
  # @option options [Integer] :performance_insights_retention_period
1860
1920
  # The amount of time, in days, to retain Performance Insights data.
1861
1921
  # Valid values are 7 or 731 (2 years).
@@ -1921,7 +1981,6 @@ module Aws::RDS
1921
1981
  # @option options [Integer] :max_allocated_storage
1922
1982
  # The upper limit to which Amazon RDS can automatically scale the
1923
1983
  # storage of the DB instance.
1924
- # @option options [String] :destination_region
1925
1984
  # @option options [String] :source_region
1926
1985
  # The source region of the snapshot. This is only needed when the
1927
1986
  # shapshot is encrypted and in a different region.
@@ -2093,6 +2152,7 @@ module Aws::RDS
2093
2152
  # max_allocated_storage: 1,
2094
2153
  # certificate_rotation_restart: false,
2095
2154
  # replica_mode: "open-read-only", # accepts open-read-only, mounted
2155
+ # enable_customer_owned_ip: false,
2096
2156
  # })
2097
2157
  # @param [Hash] options ({})
2098
2158
  # @option options [Integer] :allocated_storage
@@ -2126,8 +2186,8 @@ module Aws::RDS
2126
2186
  # The new DB subnet group for the DB instance. You can use this
2127
2187
  # parameter to move your DB instance to a different VPC. If your DB
2128
2188
  # instance isn't in a VPC, you can also use this parameter to move your
2129
- # DB instance into a VPC. For more information, see [Updating the VPC
2130
- # for a DB Instance][1] in the *Amazon RDS User Guide.*
2189
+ # DB instance into a VPC. For more information, see [Working with a DB
2190
+ # instance in a VPC][1] in the *Amazon RDS User Guide.*
2131
2191
  #
2132
2192
  # Changing the subnet group causes an outage during the change. The
2133
2193
  # change is applied during the next maintenance window, unless you
@@ -2140,7 +2200,7 @@ module Aws::RDS
2140
2200
  #
2141
2201
  #
2142
2202
  #
2143
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC
2203
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC
2144
2204
  # @option options [Array<String>] :db_security_groups
2145
2205
  # A list of DB security groups to authorize on this DB instance.
2146
2206
  # Changing this setting doesn't result in an outage and the change is
@@ -2325,8 +2385,10 @@ module Aws::RDS
2325
2385
  # family for the new engine version must be specified. The new DB
2326
2386
  # parameter group can be the default for that DB parameter group family.
2327
2387
  #
2328
- # For information about valid engine versions, see `CreateDBInstance`,
2329
- # or call `DescribeDBEngineVersions`.
2388
+ # If you specify only a major version, Amazon RDS will update the DB
2389
+ # instance to the default minor version if the current minor version is
2390
+ # lower. For information about valid engine versions, see
2391
+ # `CreateDBInstance`, or call `DescribeDBEngineVersions`.
2330
2392
  # @option options [Boolean] :allow_major_version_upgrade
2331
2393
  # A value that indicates whether major version upgrades are allowed.
2332
2394
  # Changing this parameter doesn't result in an outage and the change is
@@ -2381,14 +2443,14 @@ module Aws::RDS
2381
2443
  #
2382
2444
  # Default: Uses existing setting
2383
2445
  # @option options [String] :option_group_name
2384
- # Indicates that the DB instance should be associated with the specified
2385
- # option group. Changing this parameter doesn't result in an outage
2386
- # except in the following case and the change is applied during the next
2387
- # maintenance window unless the `ApplyImmediately` parameter is enabled
2388
- # for this request. If the parameter change results in an option group
2389
- # that enables OEM, this change can cause a brief (sub-second) period
2390
- # during which new connections are rejected but existing connections are
2391
- # not interrupted.
2446
+ # A value that indicates the DB instance should be associated with the
2447
+ # specified option group. Changing this parameter doesn't result in an
2448
+ # outage except in the following case and the change is applied during
2449
+ # the next maintenance window unless the `ApplyImmediately` parameter is
2450
+ # enabled for this request. If the parameter change results in an option
2451
+ # group that enables OEM, this change can cause a brief (sub-second)
2452
+ # period during which new connections are rejected but existing
2453
+ # connections are not interrupted.
2392
2454
  #
2393
2455
  # Permanent options, such as the TDE option for Oracle Advanced Security
2394
2456
  # TDE, can't be removed from an option group, and that option group
@@ -2597,13 +2659,15 @@ module Aws::RDS
2597
2659
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
2598
2660
  # @option options [String] :performance_insights_kms_key_id
2599
2661
  # The AWS KMS key identifier for encryption of Performance Insights
2600
- # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
2601
- # identifier, or the KMS key alias for the KMS encryption key.
2662
+ # data.
2663
+ #
2664
+ # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
2665
+ # name for the AWS KMS customer master key (CMK).
2602
2666
  #
2603
2667
  # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
2604
- # Amazon RDS uses your default encryption key. AWS KMS creates the
2605
- # default encryption key for your AWS account. Your AWS account has a
2606
- # different default encryption key for each AWS Region.
2668
+ # Amazon RDS uses your default CMK. There is a default CMK for your AWS
2669
+ # account. Your AWS account has a different default CMK for each AWS
2670
+ # Region.
2607
2671
  # @option options [Integer] :performance_insights_retention_period
2608
2672
  # The amount of time, in days, to retain Performance Insights data.
2609
2673
  # Valid values are 7 or 731 (2 years).
@@ -2678,6 +2742,25 @@ module Aws::RDS
2678
2742
  #
2679
2743
  #
2680
2744
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
2745
+ # @option options [Boolean] :enable_customer_owned_ip
2746
+ # A value that indicates whether to enable a customer-owned IP address
2747
+ # (CoIP) for an RDS on Outposts DB instance.
2748
+ #
2749
+ # A *CoIP* provides local or external connectivity to resources in your
2750
+ # Outpost subnets through your on-premises network. For some use cases,
2751
+ # a CoIP can provide lower latency for connections to the DB instance
2752
+ # from outside of its virtual private cloud (VPC) on your local network.
2753
+ #
2754
+ # For more information about RDS on Outposts, see [Working with Amazon
2755
+ # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
2756
+ #
2757
+ # For more information about CoIPs, see [Customer-owned IP addresses][2]
2758
+ # in the *AWS Outposts User Guide*.
2759
+ #
2760
+ #
2761
+ #
2762
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
2763
+ # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
2681
2764
  # @return [DBInstance]
2682
2765
  def modify(options = {})
2683
2766
  options = options.merge(db_instance_identifier: @id)
@@ -2809,6 +2892,8 @@ module Aws::RDS
2809
2892
  # deletion_protection: false,
2810
2893
  # source_dbi_resource_id: "String",
2811
2894
  # max_allocated_storage: 1,
2895
+ # source_db_instance_automated_backups_arn: "String",
2896
+ # enable_customer_owned_ip: false,
2812
2897
  # })
2813
2898
  # @param [Hash] options ({})
2814
2899
  # @option options [required, String] :target_db_instance_identifier
@@ -3061,6 +3146,29 @@ module Aws::RDS
3061
3146
  # @option options [Integer] :max_allocated_storage
3062
3147
  # The upper limit to which Amazon RDS can automatically scale the
3063
3148
  # storage of the DB instance.
3149
+ # @option options [String] :source_db_instance_automated_backups_arn
3150
+ # The Amazon Resource Name (ARN) of the replicated automated backups
3151
+ # from which to restore, for example,
3152
+ # `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
3153
+ # @option options [Boolean] :enable_customer_owned_ip
3154
+ # A value that indicates whether to enable a customer-owned IP address
3155
+ # (CoIP) for an RDS on Outposts DB instance.
3156
+ #
3157
+ # A *CoIP* provides local or external connectivity to resources in your
3158
+ # Outpost subnets through your on-premises network. For some use cases,
3159
+ # a CoIP can provide lower latency for connections to the DB instance
3160
+ # from outside of its virtual private cloud (VPC) on your local network.
3161
+ #
3162
+ # For more information about RDS on Outposts, see [Working with Amazon
3163
+ # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
3164
+ #
3165
+ # For more information about CoIPs, see [Customer-owned IP addresses][2]
3166
+ # in the *AWS Outposts User Guide*.
3167
+ #
3168
+ #
3169
+ #
3170
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
3171
+ # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
3064
3172
  # @return [DBInstance]
3065
3173
  def restore(options = {})
3066
3174
  options = options.merge(source_db_instance_identifier: @id)
@@ -174,6 +174,9 @@ module Aws::RDS
174
174
 
175
175
  # If `Encrypted` is true, the AWS KMS key identifier for the encrypted
176
176
  # DB snapshot.
177
+ #
178
+ # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
179
+ # name for the AWS KMS customer master key (CMK).
177
180
  # @return [String]
178
181
  def kms_key_id
179
182
  data[:kms_key_id]
@@ -407,6 +410,7 @@ module Aws::RDS
407
410
  # copy_tags: false,
408
411
  # pre_signed_url: "String",
409
412
  # option_group_name: "String",
413
+ # target_custom_availability_zone: "String",
410
414
  # source_region: "String",
411
415
  # })
412
416
  # @param [Hash] options ({})
@@ -425,14 +429,14 @@ module Aws::RDS
425
429
  #
426
430
  # Example: `my-db-snapshot`
427
431
  # @option options [String] :kms_key_id
428
- # The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the
429
- # Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias
430
- # for the KMS encryption key.
432
+ # The AWS KMS key identifier for an encrypted DB snapshot. The AWS KMS
433
+ # key identifier is the key ARN, key ID, alias ARN, or alias name for
434
+ # the AWS KMS customer master key (CMK).
431
435
  #
432
436
  # If you copy an encrypted DB snapshot from your AWS account, you can
433
- # specify a value for this parameter to encrypt the copy with a new KMS
434
- # encryption key. If you don't specify a value for this parameter, then
435
- # the copy of the DB snapshot is encrypted with the same KMS key as the
437
+ # specify a value for this parameter to encrypt the copy with a new AWS
438
+ # KMS CMK. If you don't specify a value for this parameter, then the
439
+ # copy of the DB snapshot is encrypted with the same AWS KMS key as the
436
440
  # source DB snapshot.
437
441
  #
438
442
  # If you copy an encrypted DB snapshot that is shared from another AWS
@@ -442,9 +446,9 @@ module Aws::RDS
442
446
  # the copy is encrypted.
443
447
  #
444
448
  # If you copy an encrypted snapshot to a different AWS Region, then you
445
- # must specify a KMS key for the destination AWS Region. KMS encryption
446
- # keys are specific to the AWS Region that they are created in, and you
447
- # can't use encryption keys from one AWS Region in another AWS Region.
449
+ # must specify a AWS KMS key identifier for the destination AWS Region.
450
+ # AWS KMS CMKs are specific to the AWS Region that they are created in,
451
+ # and you can't use CMKs from one AWS Region in another AWS Region.
448
452
  # @option options [Array<Types::Tag>] :tags
449
453
  # A list of tags. For more information, see [Tagging Amazon RDS
450
454
  # Resources][1] in the *Amazon RDS User Guide.*
@@ -481,11 +485,11 @@ module Aws::RDS
481
485
  # the us-west-2 AWS Region. For this example, the `DestinationRegion`
482
486
  # in the presigned URL must be set to the us-east-1 AWS Region.
483
487
  #
484
- # * `KmsKeyId` - The AWS KMS key identifier for the key to use to
485
- # encrypt the copy of the DB snapshot in the destination AWS Region.
486
- # This is the same identifier for both the `CopyDBSnapshot` action
487
- # that is called in the destination AWS Region, and the action
488
- # contained in the presigned URL.
488
+ # * `KmsKeyId` - The AWS KMS key identifier for the customer master key
489
+ # (CMK) to use to encrypt the copy of the DB snapshot in the
490
+ # destination AWS Region. This is the same identifier for both the
491
+ # `CopyDBSnapshot` action that is called in the destination AWS
492
+ # Region, and the action contained in the presigned URL.
489
493
  #
490
494
  # * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
491
495
  # encrypted snapshot to be copied. This identifier must be in the
@@ -519,13 +523,17 @@ module Aws::RDS
519
523
  # to another, and your DB instance uses a nondefault option group. If
520
524
  # your source DB instance uses Transparent Data Encryption for Oracle or
521
525
  # Microsoft SQL Server, you must specify this option when copying across
522
- # AWS Regions. For more information, see [Option Group
523
- # Considerations][1] in the *Amazon RDS User Guide.*
526
+ # AWS Regions. For more information, see [Option group
527
+ # considerations][1] in the *Amazon RDS User Guide.*
524
528
  #
525
529
  #
526
530
  #
527
531
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options
528
- # @option options [String] :destination_region
532
+ # @option options [String] :target_custom_availability_zone
533
+ # The external custom Availability Zone (CAZ) identifier for the target
534
+ # CAZ.
535
+ #
536
+ # Example: `rds-caz-aiqhTgQv`.
529
537
  # @option options [String] :source_region
530
538
  # The source region of the snapshot. This is only needed when the
531
539
  # shapshot is encrypted and in a different region.
@@ -597,6 +605,7 @@ module Aws::RDS
597
605
  # use_default_processor_features: false,
598
606
  # db_parameter_group_name: "String",
599
607
  # deletion_protection: false,
608
+ # enable_customer_owned_ip: false,
600
609
  # })
601
610
  # @param [Hash] options ({})
602
611
  # @option options [required, String] :db_instance_identifier
@@ -837,6 +846,25 @@ module Aws::RDS
837
846
  #
838
847
  #
839
848
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
849
+ # @option options [Boolean] :enable_customer_owned_ip
850
+ # A value that indicates whether to enable a customer-owned IP address
851
+ # (CoIP) for an RDS on Outposts DB instance.
852
+ #
853
+ # A *CoIP* provides local or external connectivity to resources in your
854
+ # Outpost subnets through your on-premises network. For some use cases,
855
+ # a CoIP can provide lower latency for connections to the DB instance
856
+ # from outside of its virtual private cloud (VPC) on your local network.
857
+ #
858
+ # For more information about RDS on Outposts, see [Working with Amazon
859
+ # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
860
+ #
861
+ # For more information about CoIPs, see [Customer-owned IP addresses][2]
862
+ # in the *AWS Outposts User Guide*.
863
+ #
864
+ #
865
+ #
866
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
867
+ # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
840
868
  # @return [DBInstance]
841
869
  def restore(options = {})
842
870
  options = options.merge(db_snapshot_identifier: @snapshot_id)