aws-sdk-rds 1.108.0 → 1.113.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +506 -73
- data/lib/aws-sdk-rds/client_api.rb +40 -0
- data/lib/aws-sdk-rds/db_cluster.rb +30 -16
- data/lib/aws-sdk-rds/db_instance.rb +170 -33
- data/lib/aws-sdk-rds/db_snapshot.rb +22 -2
- data/lib/aws-sdk-rds/option_group.rb +24 -0
- data/lib/aws-sdk-rds/resource.rb +154 -23
- data/lib/aws-sdk-rds/types.rb +550 -84
- metadata +4 -4
@@ -110,6 +110,7 @@ module Aws::RDS
|
|
110
110
|
DBClusterEndpointMessage = Shapes::StructureShape.new(name: 'DBClusterEndpointMessage')
|
111
111
|
DBClusterEndpointNotFoundFault = Shapes::StructureShape.new(name: 'DBClusterEndpointNotFoundFault')
|
112
112
|
DBClusterEndpointQuotaExceededFault = Shapes::StructureShape.new(name: 'DBClusterEndpointQuotaExceededFault')
|
113
|
+
DBClusterIdentifier = Shapes::StringShape.new(name: 'DBClusterIdentifier')
|
113
114
|
DBClusterList = Shapes::ListShape.new(name: 'DBClusterList')
|
114
115
|
DBClusterMember = Shapes::StructureShape.new(name: 'DBClusterMember')
|
115
116
|
DBClusterMemberList = Shapes::ListShape.new(name: 'DBClusterMemberList')
|
@@ -319,12 +320,17 @@ module Aws::RDS
|
|
319
320
|
ExportTasksMessage = Shapes::StructureShape.new(name: 'ExportTasksMessage')
|
320
321
|
FailoverDBClusterMessage = Shapes::StructureShape.new(name: 'FailoverDBClusterMessage')
|
321
322
|
FailoverDBClusterResult = Shapes::StructureShape.new(name: 'FailoverDBClusterResult')
|
323
|
+
FailoverGlobalClusterMessage = Shapes::StructureShape.new(name: 'FailoverGlobalClusterMessage')
|
324
|
+
FailoverGlobalClusterResult = Shapes::StructureShape.new(name: 'FailoverGlobalClusterResult')
|
325
|
+
FailoverState = Shapes::StructureShape.new(name: 'FailoverState')
|
326
|
+
FailoverStatus = Shapes::StringShape.new(name: 'FailoverStatus')
|
322
327
|
FeatureNameList = Shapes::ListShape.new(name: 'FeatureNameList')
|
323
328
|
Filter = Shapes::StructureShape.new(name: 'Filter')
|
324
329
|
FilterList = Shapes::ListShape.new(name: 'FilterList')
|
325
330
|
FilterValueList = Shapes::ListShape.new(name: 'FilterValueList')
|
326
331
|
GlobalCluster = Shapes::StructureShape.new(name: 'GlobalCluster')
|
327
332
|
GlobalClusterAlreadyExistsFault = Shapes::StructureShape.new(name: 'GlobalClusterAlreadyExistsFault')
|
333
|
+
GlobalClusterIdentifier = Shapes::StringShape.new(name: 'GlobalClusterIdentifier')
|
328
334
|
GlobalClusterList = Shapes::ListShape.new(name: 'GlobalClusterList')
|
329
335
|
GlobalClusterMember = Shapes::StructureShape.new(name: 'GlobalClusterMember')
|
330
336
|
GlobalClusterMemberList = Shapes::ListShape.new(name: 'GlobalClusterMemberList')
|
@@ -878,6 +884,7 @@ module Aws::RDS
|
|
878
884
|
CreateDBInstanceMessage.add_member(:processor_features, Shapes::ShapeRef.new(shape: ProcessorFeatureList, location_name: "ProcessorFeatures"))
|
879
885
|
CreateDBInstanceMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
880
886
|
CreateDBInstanceMessage.add_member(:max_allocated_storage, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxAllocatedStorage"))
|
887
|
+
CreateDBInstanceMessage.add_member(:enable_customer_owned_ip, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableCustomerOwnedIp"))
|
881
888
|
CreateDBInstanceMessage.struct_class = Types::CreateDBInstanceMessage
|
882
889
|
|
883
890
|
CreateDBInstanceReadReplicaMessage.add_member(:db_instance_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBInstanceIdentifier"))
|
@@ -1318,6 +1325,7 @@ module Aws::RDS
|
|
1318
1325
|
DBInstance.add_member(:max_allocated_storage, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxAllocatedStorage"))
|
1319
1326
|
DBInstance.add_member(:tag_list, Shapes::ShapeRef.new(shape: TagList, location_name: "TagList"))
|
1320
1327
|
DBInstance.add_member(:db_instance_automated_backups_replications, Shapes::ShapeRef.new(shape: DBInstanceAutomatedBackupsReplicationList, location_name: "DBInstanceAutomatedBackupsReplications"))
|
1328
|
+
DBInstance.add_member(:customer_owned_ip_enabled, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CustomerOwnedIpEnabled"))
|
1321
1329
|
DBInstance.struct_class = Types::DBInstance
|
1322
1330
|
|
1323
1331
|
DBInstanceAlreadyExistsFault.struct_class = Types::DBInstanceAlreadyExistsFault
|
@@ -2111,6 +2119,18 @@ module Aws::RDS
|
|
2111
2119
|
FailoverDBClusterResult.add_member(:db_cluster, Shapes::ShapeRef.new(shape: DBCluster, location_name: "DBCluster"))
|
2112
2120
|
FailoverDBClusterResult.struct_class = Types::FailoverDBClusterResult
|
2113
2121
|
|
2122
|
+
FailoverGlobalClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, required: true, location_name: "GlobalClusterIdentifier"))
|
2123
|
+
FailoverGlobalClusterMessage.add_member(:target_db_cluster_identifier, Shapes::ShapeRef.new(shape: DBClusterIdentifier, required: true, location_name: "TargetDbClusterIdentifier"))
|
2124
|
+
FailoverGlobalClusterMessage.struct_class = Types::FailoverGlobalClusterMessage
|
2125
|
+
|
2126
|
+
FailoverGlobalClusterResult.add_member(:global_cluster, Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalCluster"))
|
2127
|
+
FailoverGlobalClusterResult.struct_class = Types::FailoverGlobalClusterResult
|
2128
|
+
|
2129
|
+
FailoverState.add_member(:status, Shapes::ShapeRef.new(shape: FailoverStatus, location_name: "Status"))
|
2130
|
+
FailoverState.add_member(:from_db_cluster_arn, Shapes::ShapeRef.new(shape: String, location_name: "FromDbClusterArn"))
|
2131
|
+
FailoverState.add_member(:to_db_cluster_arn, Shapes::ShapeRef.new(shape: String, location_name: "ToDbClusterArn"))
|
2132
|
+
FailoverState.struct_class = Types::FailoverState
|
2133
|
+
|
2114
2134
|
FeatureNameList.member = Shapes::ShapeRef.new(shape: String)
|
2115
2135
|
|
2116
2136
|
Filter.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Name"))
|
@@ -2131,6 +2151,7 @@ module Aws::RDS
|
|
2131
2151
|
GlobalCluster.add_member(:storage_encrypted, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "StorageEncrypted"))
|
2132
2152
|
GlobalCluster.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
2133
2153
|
GlobalCluster.add_member(:global_cluster_members, Shapes::ShapeRef.new(shape: GlobalClusterMemberList, location_name: "GlobalClusterMembers"))
|
2154
|
+
GlobalCluster.add_member(:failover_state, Shapes::ShapeRef.new(shape: FailoverState, location_name: "FailoverState"))
|
2134
2155
|
GlobalCluster.struct_class = Types::GlobalCluster
|
2135
2156
|
|
2136
2157
|
GlobalClusterAlreadyExistsFault.struct_class = Types::GlobalClusterAlreadyExistsFault
|
@@ -2369,6 +2390,7 @@ module Aws::RDS
|
|
2369
2390
|
ModifyDBInstanceMessage.add_member(:max_allocated_storage, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxAllocatedStorage"))
|
2370
2391
|
ModifyDBInstanceMessage.add_member(:certificate_rotation_restart, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CertificateRotationRestart"))
|
2371
2392
|
ModifyDBInstanceMessage.add_member(:replica_mode, Shapes::ShapeRef.new(shape: ReplicaMode, location_name: "ReplicaMode"))
|
2393
|
+
ModifyDBInstanceMessage.add_member(:enable_customer_owned_ip, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableCustomerOwnedIp"))
|
2372
2394
|
ModifyDBInstanceMessage.struct_class = Types::ModifyDBInstanceMessage
|
2373
2395
|
|
2374
2396
|
ModifyDBInstanceResult.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
@@ -2438,6 +2460,8 @@ module Aws::RDS
|
|
2438
2460
|
ModifyGlobalClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "GlobalClusterIdentifier"))
|
2439
2461
|
ModifyGlobalClusterMessage.add_member(:new_global_cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "NewGlobalClusterIdentifier"))
|
2440
2462
|
ModifyGlobalClusterMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
2463
|
+
ModifyGlobalClusterMessage.add_member(:engine_version, Shapes::ShapeRef.new(shape: String, location_name: "EngineVersion"))
|
2464
|
+
ModifyGlobalClusterMessage.add_member(:allow_major_version_upgrade, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "AllowMajorVersionUpgrade"))
|
2441
2465
|
ModifyGlobalClusterMessage.struct_class = Types::ModifyGlobalClusterMessage
|
2442
2466
|
|
2443
2467
|
ModifyGlobalClusterResult.add_member(:global_cluster, Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalCluster"))
|
@@ -2936,6 +2960,7 @@ module Aws::RDS
|
|
2936
2960
|
RestoreDBInstanceFromDBSnapshotMessage.add_member(:use_default_processor_features, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "UseDefaultProcessorFeatures"))
|
2937
2961
|
RestoreDBInstanceFromDBSnapshotMessage.add_member(:db_parameter_group_name, Shapes::ShapeRef.new(shape: String, location_name: "DBParameterGroupName"))
|
2938
2962
|
RestoreDBInstanceFromDBSnapshotMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
2963
|
+
RestoreDBInstanceFromDBSnapshotMessage.add_member(:enable_customer_owned_ip, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableCustomerOwnedIp"))
|
2939
2964
|
RestoreDBInstanceFromDBSnapshotMessage.struct_class = Types::RestoreDBInstanceFromDBSnapshotMessage
|
2940
2965
|
|
2941
2966
|
RestoreDBInstanceFromDBSnapshotResult.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
@@ -3023,6 +3048,7 @@ module Aws::RDS
|
|
3023
3048
|
RestoreDBInstanceToPointInTimeMessage.add_member(:source_dbi_resource_id, Shapes::ShapeRef.new(shape: String, location_name: "SourceDbiResourceId"))
|
3024
3049
|
RestoreDBInstanceToPointInTimeMessage.add_member(:max_allocated_storage, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxAllocatedStorage"))
|
3025
3050
|
RestoreDBInstanceToPointInTimeMessage.add_member(:source_db_instance_automated_backups_arn, Shapes::ShapeRef.new(shape: String, location_name: "SourceDBInstanceAutomatedBackupsArn"))
|
3051
|
+
RestoreDBInstanceToPointInTimeMessage.add_member(:enable_customer_owned_ip, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnableCustomerOwnedIp"))
|
3026
3052
|
RestoreDBInstanceToPointInTimeMessage.struct_class = Types::RestoreDBInstanceToPointInTimeMessage
|
3027
3053
|
|
3028
3054
|
RestoreDBInstanceToPointInTimeResult.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
@@ -4405,6 +4431,18 @@ module Aws::RDS
|
|
4405
4431
|
o.errors << Shapes::ShapeRef.new(shape: InvalidDBInstanceStateFault)
|
4406
4432
|
end)
|
4407
4433
|
|
4434
|
+
api.add_operation(:failover_global_cluster, Seahorse::Model::Operation.new.tap do |o|
|
4435
|
+
o.name = "FailoverGlobalCluster"
|
4436
|
+
o.http_method = "POST"
|
4437
|
+
o.http_request_uri = "/"
|
4438
|
+
o.input = Shapes::ShapeRef.new(shape: FailoverGlobalClusterMessage)
|
4439
|
+
o.output = Shapes::ShapeRef.new(shape: FailoverGlobalClusterResult)
|
4440
|
+
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterNotFoundFault)
|
4441
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidGlobalClusterStateFault)
|
4442
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidDBClusterStateFault)
|
4443
|
+
o.errors << Shapes::ShapeRef.new(shape: DBClusterNotFoundFault)
|
4444
|
+
end)
|
4445
|
+
|
4408
4446
|
api.add_operation(:import_installation_media, Seahorse::Model::Operation.new.tap do |o|
|
4409
4447
|
o.name = "ImportInstallationMedia"
|
4410
4448
|
o.http_method = "POST"
|
@@ -4616,6 +4654,8 @@ module Aws::RDS
|
|
4616
4654
|
o.output = Shapes::ShapeRef.new(shape: ModifyGlobalClusterResult)
|
4617
4655
|
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterNotFoundFault)
|
4618
4656
|
o.errors << Shapes::ShapeRef.new(shape: InvalidGlobalClusterStateFault)
|
4657
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidDBClusterStateFault)
|
4658
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidDBInstanceStateFault)
|
4619
4659
|
end)
|
4620
4660
|
|
4621
4661
|
api.add_operation(:modify_option_group, Seahorse::Model::Operation.new.tap do |o|
|
@@ -471,9 +471,9 @@ module Aws::RDS
|
|
471
471
|
data[:global_write_forwarding_requested]
|
472
472
|
end
|
473
473
|
|
474
|
-
#
|
475
|
-
# only included when changes are pending. Specific
|
476
|
-
# identified by subelements.
|
474
|
+
# A value that specifies that changes to the DB cluster are pending.
|
475
|
+
# This element is only included when changes are pending. Specific
|
476
|
+
# changes are identified by subelements.
|
477
477
|
# @return [Types::ClusterPendingModifiedValues]
|
478
478
|
def pending_modified_values
|
479
479
|
data[:pending_modified_values]
|
@@ -935,7 +935,7 @@ module Aws::RDS
|
|
935
935
|
#
|
936
936
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
937
937
|
# @option options [String] :engine_mode
|
938
|
-
# The DB engine mode of the DB cluster, either `provisioned
|
938
|
+
# The DB engine mode of the DB cluster, either `provisioned`,
|
939
939
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
940
940
|
#
|
941
941
|
# The `parallelquery` engine mode isn't required for Aurora MySQL
|
@@ -1015,12 +1015,19 @@ module Aws::RDS
|
|
1015
1015
|
# Specify the name of the IAM role to be used when making API calls to
|
1016
1016
|
# the Directory Service.
|
1017
1017
|
# @option options [Boolean] :enable_global_write_forwarding
|
1018
|
-
# A value that indicates whether to enable
|
1019
|
-
#
|
1020
|
-
#
|
1021
|
-
#
|
1022
|
-
#
|
1023
|
-
#
|
1018
|
+
# A value that indicates whether to enable this DB cluster to forward
|
1019
|
+
# write operations to the primary cluster of an Aurora global database
|
1020
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
1021
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
1022
|
+
# database.
|
1023
|
+
#
|
1024
|
+
# You can set this value only on Aurora DB clusters that are members of
|
1025
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
1026
|
+
# cluster can forward writes to the current primary cluster and the
|
1027
|
+
# resulting changes are replicated back to this cluster. For the primary
|
1028
|
+
# DB cluster of an Aurora global database, this value is used
|
1029
|
+
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
1030
|
+
# operation, but it does nothing until then.
|
1024
1031
|
# @option options [String] :source_region
|
1025
1032
|
# The source region of the snapshot. This is only needed when the
|
1026
1033
|
# shapshot is encrypted and in a different region.
|
@@ -1410,12 +1417,19 @@ module Aws::RDS
|
|
1410
1417
|
# A value that indicates whether to copy all tags from the DB cluster to
|
1411
1418
|
# snapshots of the DB cluster. The default is not to copy them.
|
1412
1419
|
# @option options [Boolean] :enable_global_write_forwarding
|
1413
|
-
# A value that indicates whether to enable
|
1414
|
-
#
|
1415
|
-
#
|
1416
|
-
#
|
1417
|
-
#
|
1418
|
-
#
|
1420
|
+
# A value that indicates whether to enable this DB cluster to forward
|
1421
|
+
# write operations to the primary cluster of an Aurora global database
|
1422
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
1423
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
1424
|
+
# database.
|
1425
|
+
#
|
1426
|
+
# You can set this value only on Aurora DB clusters that are members of
|
1427
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
1428
|
+
# cluster can forward writes to the current primary cluster and the
|
1429
|
+
# resulting changes are replicated back to this cluster. For the primary
|
1430
|
+
# DB cluster of an Aurora global database, this value is used
|
1431
|
+
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
1432
|
+
# operation, but it does nothing until then.
|
1419
1433
|
# @return [DBCluster]
|
1420
1434
|
def modify(options = {})
|
1421
1435
|
options = options.merge(db_cluster_identifier: @id)
|
@@ -163,9 +163,9 @@ module Aws::RDS
|
|
163
163
|
data[:preferred_maintenance_window]
|
164
164
|
end
|
165
165
|
|
166
|
-
#
|
167
|
-
# only included when changes are pending. Specific
|
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
|
-
#
|
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]
|
@@ -545,6 +546,30 @@ module Aws::RDS
|
|
545
546
|
data[:db_instance_automated_backups_replications]
|
546
547
|
end
|
547
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
|
+
|
548
573
|
# @!endgroup
|
549
574
|
|
550
575
|
# @return [Client]
|
@@ -738,6 +763,7 @@ module Aws::RDS
|
|
738
763
|
# ],
|
739
764
|
# deletion_protection: false,
|
740
765
|
# max_allocated_storage: 1,
|
766
|
+
# enable_customer_owned_ip: false,
|
741
767
|
# })
|
742
768
|
# @param [Hash] options ({})
|
743
769
|
# @option options [String] :db_name
|
@@ -777,8 +803,8 @@ module Aws::RDS
|
|
777
803
|
# **PostgreSQL**
|
778
804
|
#
|
779
805
|
# The name of the database to create when the DB instance is created. If
|
780
|
-
# this parameter isn't specified,
|
781
|
-
# instance.
|
806
|
+
# this parameter isn't specified, a database named `postgres` is
|
807
|
+
# created in the DB instance.
|
782
808
|
#
|
783
809
|
# Constraints:
|
784
810
|
#
|
@@ -807,17 +833,34 @@ module Aws::RDS
|
|
807
833
|
#
|
808
834
|
# Not applicable. Must be null.
|
809
835
|
#
|
810
|
-
# **Amazon Aurora**
|
836
|
+
# **Amazon Aurora MySQL**
|
811
837
|
#
|
812
|
-
# The name of the database to create when the primary instance of the
|
813
|
-
# cluster is created. If this parameter isn't specified
|
814
|
-
# created in the DB
|
838
|
+
# The name of the database to create when the primary DB instance of the
|
839
|
+
# Aurora MySQL DB cluster is created. If this parameter isn't specified
|
840
|
+
# for an Aurora MySQL DB cluster, no database is created in the DB
|
841
|
+
# cluster.
|
815
842
|
#
|
816
843
|
# Constraints:
|
817
844
|
#
|
818
|
-
# *
|
845
|
+
# * It must contain 1 to 64 alphanumeric characters.
|
819
846
|
#
|
820
|
-
# *
|
847
|
+
# * It can't be a word reserved by the database engine.
|
848
|
+
#
|
849
|
+
# **Amazon Aurora PostgreSQL**
|
850
|
+
#
|
851
|
+
# The name of the database to create when the primary DB instance of the
|
852
|
+
# Aurora PostgreSQL DB cluster is created. If this parameter isn't
|
853
|
+
# specified for an Aurora PostgreSQL DB cluster, a database named
|
854
|
+
# `postgres` is created in the DB cluster.
|
855
|
+
#
|
856
|
+
# Constraints:
|
857
|
+
#
|
858
|
+
# * It must contain 1 to 63 alphanumeric characters.
|
859
|
+
#
|
860
|
+
# * It must begin with a letter or an underscore. Subsequent characters
|
861
|
+
# can be letters, underscores, or digits (0 to 9).
|
862
|
+
#
|
863
|
+
# * It can't be a word reserved by the database engine.
|
821
864
|
# @option options [Integer] :allocated_storage
|
822
865
|
# The amount of storage (in gibibytes) to allocate for the DB instance.
|
823
866
|
#
|
@@ -1076,8 +1119,8 @@ module Aws::RDS
|
|
1076
1119
|
# specify the identifier of the custom Availability Zone to create the
|
1077
1120
|
# DB instance in.
|
1078
1121
|
#
|
1079
|
-
# For more information about RDS on VMware, see the [
|
1080
|
-
#
|
1122
|
+
# For more information about RDS on VMware, see the [ RDS on VMware User
|
1123
|
+
# Guide.][2]
|
1081
1124
|
#
|
1082
1125
|
# </note>
|
1083
1126
|
#
|
@@ -1253,8 +1296,8 @@ module Aws::RDS
|
|
1253
1296
|
#
|
1254
1297
|
# **PostgreSQL**
|
1255
1298
|
#
|
1256
|
-
# See [
|
1257
|
-
# User Guide.*
|
1299
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][5] in the
|
1300
|
+
# *Amazon RDS User Guide.*
|
1258
1301
|
#
|
1259
1302
|
#
|
1260
1303
|
#
|
@@ -1262,7 +1305,7 @@ module Aws::RDS
|
|
1262
1305
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
1263
1306
|
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
1264
1307
|
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
1265
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
1308
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
1266
1309
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1267
1310
|
# A value that indicates whether minor engine upgrades are applied
|
1268
1311
|
# automatically to the DB instance during the maintenance window. By
|
@@ -1287,8 +1330,8 @@ module Aws::RDS
|
|
1287
1330
|
#
|
1288
1331
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
1289
1332
|
# @option options [String] :option_group_name
|
1290
|
-
#
|
1291
|
-
# option group.
|
1333
|
+
# A value that indicates that the DB instance should be associated with
|
1334
|
+
# the specified option group.
|
1292
1335
|
#
|
1293
1336
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
1294
1337
|
# TDE, can't be removed from an option group. Also, that option group
|
@@ -1508,7 +1551,8 @@ module Aws::RDS
|
|
1508
1551
|
#
|
1509
1552
|
# **Oracle**
|
1510
1553
|
#
|
1511
|
-
# Possible values are `alert`, `audit`, `listener`,
|
1554
|
+
# Possible values are `alert`, `audit`, `listener`, `trace`, and
|
1555
|
+
# `oemagent`.
|
1512
1556
|
#
|
1513
1557
|
# **PostgreSQL**
|
1514
1558
|
#
|
@@ -1539,6 +1583,33 @@ module Aws::RDS
|
|
1539
1583
|
# @option options [Integer] :max_allocated_storage
|
1540
1584
|
# The upper limit to which Amazon RDS can automatically scale the
|
1541
1585
|
# storage of the DB instance.
|
1586
|
+
#
|
1587
|
+
# For more information about this setting, including limitations that
|
1588
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
1589
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
1590
|
+
#
|
1591
|
+
#
|
1592
|
+
#
|
1593
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
1594
|
+
# @option options [Boolean] :enable_customer_owned_ip
|
1595
|
+
# A value that indicates whether to enable a customer-owned IP address
|
1596
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
1597
|
+
#
|
1598
|
+
# A *CoIP* provides local or external connectivity to resources in your
|
1599
|
+
# Outpost subnets through your on-premises network. For some use cases,
|
1600
|
+
# a CoIP can provide lower latency for connections to the DB instance
|
1601
|
+
# from outside of its virtual private cloud (VPC) on your local network.
|
1602
|
+
#
|
1603
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
1604
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
1605
|
+
#
|
1606
|
+
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
1607
|
+
# in the *AWS Outposts User Guide*.
|
1608
|
+
#
|
1609
|
+
#
|
1610
|
+
#
|
1611
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
1612
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
1542
1613
|
# @return [DBInstance]
|
1543
1614
|
def create(options = {})
|
1544
1615
|
options = options.merge(db_instance_identifier: @id)
|
@@ -1935,6 +2006,14 @@ module Aws::RDS
|
|
1935
2006
|
# @option options [Integer] :max_allocated_storage
|
1936
2007
|
# The upper limit to which Amazon RDS can automatically scale the
|
1937
2008
|
# storage of the DB instance.
|
2009
|
+
#
|
2010
|
+
# For more information about this setting, including limitations that
|
2011
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
2012
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
2013
|
+
#
|
2014
|
+
#
|
2015
|
+
#
|
2016
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
1938
2017
|
# @option options [String] :source_region
|
1939
2018
|
# The source region of the snapshot. This is only needed when the
|
1940
2019
|
# shapshot is encrypted and in a different region.
|
@@ -2106,6 +2185,7 @@ module Aws::RDS
|
|
2106
2185
|
# max_allocated_storage: 1,
|
2107
2186
|
# certificate_rotation_restart: false,
|
2108
2187
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
2188
|
+
# enable_customer_owned_ip: false,
|
2109
2189
|
# })
|
2110
2190
|
# @param [Hash] options ({})
|
2111
2191
|
# @option options [Integer] :allocated_storage
|
@@ -2139,8 +2219,8 @@ module Aws::RDS
|
|
2139
2219
|
# The new DB subnet group for the DB instance. You can use this
|
2140
2220
|
# parameter to move your DB instance to a different VPC. If your DB
|
2141
2221
|
# instance isn't in a VPC, you can also use this parameter to move your
|
2142
|
-
# DB instance into a VPC. For more information, see [
|
2143
|
-
#
|
2222
|
+
# DB instance into a VPC. For more information, see [Working with a DB
|
2223
|
+
# instance in a VPC][1] in the *Amazon RDS User Guide.*
|
2144
2224
|
#
|
2145
2225
|
# Changing the subnet group causes an outage during the change. The
|
2146
2226
|
# change is applied during the next maintenance window, unless you
|
@@ -2153,7 +2233,7 @@ module Aws::RDS
|
|
2153
2233
|
#
|
2154
2234
|
#
|
2155
2235
|
#
|
2156
|
-
# [1]:
|
2236
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC
|
2157
2237
|
# @option options [Array<String>] :db_security_groups
|
2158
2238
|
# A list of DB security groups to authorize on this DB instance.
|
2159
2239
|
# Changing this setting doesn't result in an outage and the change is
|
@@ -2338,8 +2418,10 @@ module Aws::RDS
|
|
2338
2418
|
# family for the new engine version must be specified. The new DB
|
2339
2419
|
# parameter group can be the default for that DB parameter group family.
|
2340
2420
|
#
|
2341
|
-
#
|
2342
|
-
#
|
2421
|
+
# If you specify only a major version, Amazon RDS will update the DB
|
2422
|
+
# instance to the default minor version if the current minor version is
|
2423
|
+
# lower. For information about valid engine versions, see
|
2424
|
+
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
2343
2425
|
# @option options [Boolean] :allow_major_version_upgrade
|
2344
2426
|
# A value that indicates whether major version upgrades are allowed.
|
2345
2427
|
# Changing this parameter doesn't result in an outage and the change is
|
@@ -2394,14 +2476,14 @@ module Aws::RDS
|
|
2394
2476
|
#
|
2395
2477
|
# Default: Uses existing setting
|
2396
2478
|
# @option options [String] :option_group_name
|
2397
|
-
#
|
2398
|
-
# option group. Changing this parameter doesn't result in an
|
2399
|
-
# except in the following case and the change is applied during
|
2400
|
-
# maintenance window unless the `ApplyImmediately` parameter is
|
2401
|
-
# for this request. If the parameter change results in an option
|
2402
|
-
# that enables OEM, this change can cause a brief (sub-second)
|
2403
|
-
# during which new connections are rejected but existing
|
2404
|
-
# not interrupted.
|
2479
|
+
# A value that indicates the DB instance should be associated with the
|
2480
|
+
# specified option group. Changing this parameter doesn't result in an
|
2481
|
+
# outage except in the following case and the change is applied during
|
2482
|
+
# the next maintenance window unless the `ApplyImmediately` parameter is
|
2483
|
+
# enabled for this request. If the parameter change results in an option
|
2484
|
+
# group that enables OEM, this change can cause a brief (sub-second)
|
2485
|
+
# period during which new connections are rejected but existing
|
2486
|
+
# connections are not interrupted.
|
2405
2487
|
#
|
2406
2488
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
2407
2489
|
# TDE, can't be removed from an option group, and that option group
|
@@ -2647,6 +2729,14 @@ module Aws::RDS
|
|
2647
2729
|
# @option options [Integer] :max_allocated_storage
|
2648
2730
|
# The upper limit to which Amazon RDS can automatically scale the
|
2649
2731
|
# storage of the DB instance.
|
2732
|
+
#
|
2733
|
+
# For more information about this setting, including limitations that
|
2734
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
2735
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
2736
|
+
#
|
2737
|
+
#
|
2738
|
+
#
|
2739
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
2650
2740
|
# @option options [Boolean] :certificate_rotation_restart
|
2651
2741
|
# A value that indicates whether the DB instance is restarted when you
|
2652
2742
|
# rotate your SSL/TLS certificate.
|
@@ -2693,6 +2783,25 @@ module Aws::RDS
|
|
2693
2783
|
#
|
2694
2784
|
#
|
2695
2785
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
2786
|
+
# @option options [Boolean] :enable_customer_owned_ip
|
2787
|
+
# A value that indicates whether to enable a customer-owned IP address
|
2788
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
2789
|
+
#
|
2790
|
+
# A *CoIP* provides local or external connectivity to resources in your
|
2791
|
+
# Outpost subnets through your on-premises network. For some use cases,
|
2792
|
+
# a CoIP can provide lower latency for connections to the DB instance
|
2793
|
+
# from outside of its virtual private cloud (VPC) on your local network.
|
2794
|
+
#
|
2795
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
2796
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
2797
|
+
#
|
2798
|
+
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
2799
|
+
# in the *AWS Outposts User Guide*.
|
2800
|
+
#
|
2801
|
+
#
|
2802
|
+
#
|
2803
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2804
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
2696
2805
|
# @return [DBInstance]
|
2697
2806
|
def modify(options = {})
|
2698
2807
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2825,6 +2934,7 @@ module Aws::RDS
|
|
2825
2934
|
# source_dbi_resource_id: "String",
|
2826
2935
|
# max_allocated_storage: 1,
|
2827
2936
|
# source_db_instance_automated_backups_arn: "String",
|
2937
|
+
# enable_customer_owned_ip: false,
|
2828
2938
|
# })
|
2829
2939
|
# @param [Hash] options ({})
|
2830
2940
|
# @option options [required, String] :target_db_instance_identifier
|
@@ -3077,10 +3187,37 @@ module Aws::RDS
|
|
3077
3187
|
# @option options [Integer] :max_allocated_storage
|
3078
3188
|
# The upper limit to which Amazon RDS can automatically scale the
|
3079
3189
|
# storage of the DB instance.
|
3190
|
+
#
|
3191
|
+
# For more information about this setting, including limitations that
|
3192
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
3193
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
3194
|
+
#
|
3195
|
+
#
|
3196
|
+
#
|
3197
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
3080
3198
|
# @option options [String] :source_db_instance_automated_backups_arn
|
3081
3199
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
3082
3200
|
# from which to restore, for example,
|
3083
3201
|
# `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
3202
|
+
# @option options [Boolean] :enable_customer_owned_ip
|
3203
|
+
# A value that indicates whether to enable a customer-owned IP address
|
3204
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
3205
|
+
#
|
3206
|
+
# A *CoIP* provides local or external connectivity to resources in your
|
3207
|
+
# Outpost subnets through your on-premises network. For some use cases,
|
3208
|
+
# a CoIP can provide lower latency for connections to the DB instance
|
3209
|
+
# from outside of its virtual private cloud (VPC) on your local network.
|
3210
|
+
#
|
3211
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
3212
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
3213
|
+
#
|
3214
|
+
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
3215
|
+
# in the *AWS Outposts User Guide*.
|
3216
|
+
#
|
3217
|
+
#
|
3218
|
+
#
|
3219
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
3220
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
3084
3221
|
# @return [DBInstance]
|
3085
3222
|
def restore(options = {})
|
3086
3223
|
options = options.merge(source_db_instance_identifier: @id)
|