aws-sdk-rds 1.112.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 +129 -13
- data/lib/aws-sdk-rds/client_api.rb +31 -0
- data/lib/aws-sdk-rds/db_cluster.rb +26 -12
- data/lib/aws-sdk-rds/resource.rb +13 -6
- data/lib/aws-sdk-rds/types.rb +133 -13
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c3363a6bc7204b510ba06cbe33e4c2548d78304b2c81207e5936b3f4c2c81549
|
4
|
+
data.tar.gz: 21db21a446a8ece9a44156f0d3d3192dc82294e9d7266a3eb00b732b19cfa26c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '08aa13d4ac3854a22e718003ebd5bacc6b7e841f718444694856cf038ce17ae417af892609f8ae7e1bc305ebcd818a6fc89f45114492e2909c2601df5b0bf84a'
|
7
|
+
data.tar.gz: 88666a9d24e97a980e7f67a2718aab00725ec0a9bf0f505e04dc44007769b1555428a60350cc8d72b55ad4e9d04b6ce185a1c63c73f1733c4a01bfbeb48d8c86
|
data/lib/aws-sdk-rds.rb
CHANGED
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -2236,12 +2236,19 @@ module Aws::RDS
|
|
2236
2236
|
# the Directory Service.
|
2237
2237
|
#
|
2238
2238
|
# @option params [Boolean] :enable_global_write_forwarding
|
2239
|
-
# A value that indicates whether to enable
|
2240
|
-
#
|
2241
|
-
#
|
2242
|
-
#
|
2243
|
-
#
|
2244
|
-
#
|
2239
|
+
# A value that indicates whether to enable this DB cluster to forward
|
2240
|
+
# write operations to the primary cluster of an Aurora global database
|
2241
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
2242
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
2243
|
+
# database.
|
2244
|
+
#
|
2245
|
+
# You can set this value only on Aurora DB clusters that are members of
|
2246
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
2247
|
+
# cluster can forward writes to the current primary cluster and the
|
2248
|
+
# resulting changes are replicated back to this cluster. For the primary
|
2249
|
+
# DB cluster of an Aurora global database, this value is used
|
2250
|
+
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
2251
|
+
# operation, but it does nothing until then.
|
2245
2252
|
#
|
2246
2253
|
# @option params [String] :source_region
|
2247
2254
|
# The source region of the snapshot. This is only needed when the
|
@@ -5290,6 +5297,9 @@ module Aws::RDS
|
|
5290
5297
|
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
5291
5298
|
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
5292
5299
|
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
5300
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
5301
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
5302
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
5293
5303
|
#
|
5294
5304
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateGlobalCluster AWS API Documentation
|
5295
5305
|
#
|
@@ -6529,6 +6539,9 @@ module Aws::RDS
|
|
6529
6539
|
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
6530
6540
|
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
6531
6541
|
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
6542
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
6543
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
6544
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
6532
6545
|
#
|
6533
6546
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteGlobalCluster AWS API Documentation
|
6534
6547
|
#
|
@@ -9926,6 +9939,9 @@ module Aws::RDS
|
|
9926
9939
|
# resp.global_clusters[0].global_cluster_members[0].readers[0] #=> String
|
9927
9940
|
# resp.global_clusters[0].global_cluster_members[0].is_writer #=> Boolean
|
9928
9941
|
# resp.global_clusters[0].global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
9942
|
+
# resp.global_clusters[0].failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
9943
|
+
# resp.global_clusters[0].failover_state.from_db_cluster_arn #=> String
|
9944
|
+
# resp.global_clusters[0].failover_state.to_db_cluster_arn #=> String
|
9929
9945
|
#
|
9930
9946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeGlobalClusters AWS API Documentation
|
9931
9947
|
#
|
@@ -11254,6 +11270,93 @@ module Aws::RDS
|
|
11254
11270
|
req.send_request(options)
|
11255
11271
|
end
|
11256
11272
|
|
11273
|
+
# Initiates the failover process for an Aurora global database
|
11274
|
+
# (GlobalCluster).
|
11275
|
+
#
|
11276
|
+
# A failover for an Aurora global database promotes one of secondary
|
11277
|
+
# read-only DB clusters to be the primary DB cluster and demotes the
|
11278
|
+
# primary DB cluster to being a secondary (read-only) DB cluster. In
|
11279
|
+
# other words, the role of the current primary DB cluster and the
|
11280
|
+
# selected (target) DB cluster are switched. The selected secondary DB
|
11281
|
+
# cluster assumes full read/write capabilities for the Aurora global
|
11282
|
+
# database.
|
11283
|
+
#
|
11284
|
+
# For more information about failing over an Amazon Aurora global
|
11285
|
+
# database, see [Managed planned failover for Amazon Aurora global
|
11286
|
+
# databases][1] in the *Amazon Aurora User Guide.*
|
11287
|
+
#
|
11288
|
+
# <note markdown="1"> This action applies to GlobalCluster (Aurora global databases) only.
|
11289
|
+
# Use this action only on healthy Aurora global databases with running
|
11290
|
+
# Aurora DB clusters and no Region-wide outages, to test disaster
|
11291
|
+
# recovery scenarios or to reconfigure your Aurora global database
|
11292
|
+
# topology.
|
11293
|
+
#
|
11294
|
+
# </note>
|
11295
|
+
#
|
11296
|
+
#
|
11297
|
+
#
|
11298
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.managed-failover
|
11299
|
+
#
|
11300
|
+
# @option params [required, String] :global_cluster_identifier
|
11301
|
+
# Identifier of the Aurora global database (GlobalCluster) that should
|
11302
|
+
# be failed over. The identifier is the unique key assigned by the user
|
11303
|
+
# when the Aurora global database was created. In other words, it's the
|
11304
|
+
# name of the Aurora global database that you want to fail over.
|
11305
|
+
#
|
11306
|
+
# Constraints:
|
11307
|
+
#
|
11308
|
+
# * Must match the identifier of an existing GlobalCluster (Aurora
|
11309
|
+
# global database).
|
11310
|
+
#
|
11311
|
+
# ^
|
11312
|
+
#
|
11313
|
+
# @option params [required, String] :target_db_cluster_identifier
|
11314
|
+
# Identifier of the secondary Aurora DB cluster that you want to promote
|
11315
|
+
# to primary for the Aurora global database (GlobalCluster.) Use the
|
11316
|
+
# Amazon Resource Name (ARN) for the identifier so that Aurora can
|
11317
|
+
# locate the cluster in its AWS Region.
|
11318
|
+
#
|
11319
|
+
# @return [Types::FailoverGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11320
|
+
#
|
11321
|
+
# * {Types::FailoverGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
11322
|
+
#
|
11323
|
+
# @example Request syntax with placeholder values
|
11324
|
+
#
|
11325
|
+
# resp = client.failover_global_cluster({
|
11326
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
11327
|
+
# target_db_cluster_identifier: "DBClusterIdentifier", # required
|
11328
|
+
# })
|
11329
|
+
#
|
11330
|
+
# @example Response structure
|
11331
|
+
#
|
11332
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
11333
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
11334
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
11335
|
+
# resp.global_cluster.status #=> String
|
11336
|
+
# resp.global_cluster.engine #=> String
|
11337
|
+
# resp.global_cluster.engine_version #=> String
|
11338
|
+
# resp.global_cluster.database_name #=> String
|
11339
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
11340
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
11341
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
11342
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
11343
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
11344
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
11345
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
11346
|
+
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
11347
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
11348
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
11349
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
11350
|
+
#
|
11351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverGlobalCluster AWS API Documentation
|
11352
|
+
#
|
11353
|
+
# @overload failover_global_cluster(params = {})
|
11354
|
+
# @param [Hash] params ({})
|
11355
|
+
def failover_global_cluster(params = {}, options = {})
|
11356
|
+
req = build_request(:failover_global_cluster, params)
|
11357
|
+
req.send_request(options)
|
11358
|
+
end
|
11359
|
+
|
11257
11360
|
# Imports the installation media for a DB engine that requires an
|
11258
11361
|
# on-premises customer provided license, such as SQL Server.
|
11259
11362
|
#
|
@@ -11874,12 +11977,19 @@ module Aws::RDS
|
|
11874
11977
|
# snapshots of the DB cluster. The default is not to copy them.
|
11875
11978
|
#
|
11876
11979
|
# @option params [Boolean] :enable_global_write_forwarding
|
11877
|
-
# A value that indicates whether to enable
|
11878
|
-
#
|
11879
|
-
#
|
11880
|
-
#
|
11881
|
-
#
|
11882
|
-
#
|
11980
|
+
# A value that indicates whether to enable this DB cluster to forward
|
11981
|
+
# write operations to the primary cluster of an Aurora global database
|
11982
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
11983
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
11984
|
+
# database.
|
11985
|
+
#
|
11986
|
+
# You can set this value only on Aurora DB clusters that are members of
|
11987
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
11988
|
+
# cluster can forward writes to the current primary cluster and the
|
11989
|
+
# resulting changes are replicated back to this cluster. For the primary
|
11990
|
+
# DB cluster of an Aurora global database, this value is used
|
11991
|
+
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
11992
|
+
# operation, but it does nothing until then.
|
11883
11993
|
#
|
11884
11994
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11885
11995
|
#
|
@@ -14001,6 +14111,9 @@ module Aws::RDS
|
|
14001
14111
|
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
14002
14112
|
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
14003
14113
|
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
14114
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
14115
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
14116
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
14004
14117
|
#
|
14005
14118
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyGlobalCluster AWS API Documentation
|
14006
14119
|
#
|
@@ -14870,6 +14983,9 @@ module Aws::RDS
|
|
14870
14983
|
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
14871
14984
|
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
14872
14985
|
# resp.global_cluster.global_cluster_members[0].global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
14986
|
+
# resp.global_cluster.failover_state.status #=> String, one of "pending", "failing-over", "cancelling"
|
14987
|
+
# resp.global_cluster.failover_state.from_db_cluster_arn #=> String
|
14988
|
+
# resp.global_cluster.failover_state.to_db_cluster_arn #=> String
|
14873
14989
|
#
|
14874
14990
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RemoveFromGlobalCluster AWS API Documentation
|
14875
14991
|
#
|
@@ -19399,7 +19515,7 @@ module Aws::RDS
|
|
19399
19515
|
params: params,
|
19400
19516
|
config: config)
|
19401
19517
|
context[:gem_name] = 'aws-sdk-rds'
|
19402
|
-
context[:gem_version] = '1.
|
19518
|
+
context[:gem_version] = '1.113.0'
|
19403
19519
|
Seahorse::Client::Request.new(handlers, context)
|
19404
19520
|
end
|
19405
19521
|
|
@@ -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')
|
@@ -2113,6 +2119,18 @@ module Aws::RDS
|
|
2113
2119
|
FailoverDBClusterResult.add_member(:db_cluster, Shapes::ShapeRef.new(shape: DBCluster, location_name: "DBCluster"))
|
2114
2120
|
FailoverDBClusterResult.struct_class = Types::FailoverDBClusterResult
|
2115
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
|
+
|
2116
2134
|
FeatureNameList.member = Shapes::ShapeRef.new(shape: String)
|
2117
2135
|
|
2118
2136
|
Filter.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Name"))
|
@@ -2133,6 +2151,7 @@ module Aws::RDS
|
|
2133
2151
|
GlobalCluster.add_member(:storage_encrypted, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "StorageEncrypted"))
|
2134
2152
|
GlobalCluster.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
2135
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"))
|
2136
2155
|
GlobalCluster.struct_class = Types::GlobalCluster
|
2137
2156
|
|
2138
2157
|
GlobalClusterAlreadyExistsFault.struct_class = Types::GlobalClusterAlreadyExistsFault
|
@@ -4412,6 +4431,18 @@ module Aws::RDS
|
|
4412
4431
|
o.errors << Shapes::ShapeRef.new(shape: InvalidDBInstanceStateFault)
|
4413
4432
|
end)
|
4414
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
|
+
|
4415
4446
|
api.add_operation(:import_installation_media, Seahorse::Model::Operation.new.tap do |o|
|
4416
4447
|
o.name = "ImportInstallationMedia"
|
4417
4448
|
o.http_method = "POST"
|
@@ -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)
|
data/lib/aws-sdk-rds/resource.rb
CHANGED
@@ -451,12 +451,19 @@ module Aws::RDS
|
|
451
451
|
# Specify the name of the IAM role to be used when making API calls to
|
452
452
|
# the Directory Service.
|
453
453
|
# @option options [Boolean] :enable_global_write_forwarding
|
454
|
-
# A value that indicates whether to enable
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
454
|
+
# A value that indicates whether to enable this DB cluster to forward
|
455
|
+
# write operations to the primary cluster of an Aurora global database
|
456
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
457
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
458
|
+
# database.
|
459
|
+
#
|
460
|
+
# You can set this value only on Aurora DB clusters that are members of
|
461
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
462
|
+
# cluster can forward writes to the current primary cluster and the
|
463
|
+
# resulting changes are replicated back to this cluster. For the primary
|
464
|
+
# DB cluster of an Aurora global database, this value is used
|
465
|
+
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
466
|
+
# operation, but it does nothing until then.
|
460
467
|
# @option options [String] :source_region
|
461
468
|
# The source region of the snapshot. This is only needed when the
|
462
469
|
# shapshot is encrypted and in a different region.
|
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -2197,12 +2197,19 @@ module Aws::RDS
|
|
2197
2197
|
# @return [String]
|
2198
2198
|
#
|
2199
2199
|
# @!attribute [rw] enable_global_write_forwarding
|
2200
|
-
# A value that indicates whether to enable
|
2201
|
-
#
|
2202
|
-
#
|
2203
|
-
#
|
2204
|
-
#
|
2205
|
-
#
|
2200
|
+
# A value that indicates whether to enable this DB cluster to forward
|
2201
|
+
# write operations to the primary cluster of an Aurora global database
|
2202
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
2203
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
2204
|
+
# database.
|
2205
|
+
#
|
2206
|
+
# You can set this value only on Aurora DB clusters that are members
|
2207
|
+
# of an Aurora global database. With this parameter enabled, a
|
2208
|
+
# secondary cluster can forward writes to the current primary cluster
|
2209
|
+
# and the resulting changes are replicated back to this cluster. For
|
2210
|
+
# the primary DB cluster of an Aurora global database, this value is
|
2211
|
+
# used immediately if the primary is demoted by the
|
2212
|
+
# FailoverGlobalCluster API operation, but it does nothing until then.
|
2206
2213
|
# @return [Boolean]
|
2207
2214
|
#
|
2208
2215
|
# @!attribute [rw] source_region
|
@@ -12178,6 +12185,103 @@ module Aws::RDS
|
|
12178
12185
|
include Aws::Structure
|
12179
12186
|
end
|
12180
12187
|
|
12188
|
+
# @note When making an API call, you may pass FailoverGlobalClusterMessage
|
12189
|
+
# data as a hash:
|
12190
|
+
#
|
12191
|
+
# {
|
12192
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
12193
|
+
# target_db_cluster_identifier: "DBClusterIdentifier", # required
|
12194
|
+
# }
|
12195
|
+
#
|
12196
|
+
# @!attribute [rw] global_cluster_identifier
|
12197
|
+
# Identifier of the Aurora global database (GlobalCluster) that should
|
12198
|
+
# be failed over. The identifier is the unique key assigned by the
|
12199
|
+
# user when the Aurora global database was created. In other words,
|
12200
|
+
# it's the name of the Aurora global database that you want to fail
|
12201
|
+
# over.
|
12202
|
+
#
|
12203
|
+
# Constraints:
|
12204
|
+
#
|
12205
|
+
# * Must match the identifier of an existing GlobalCluster (Aurora
|
12206
|
+
# global database).
|
12207
|
+
#
|
12208
|
+
# ^
|
12209
|
+
# @return [String]
|
12210
|
+
#
|
12211
|
+
# @!attribute [rw] target_db_cluster_identifier
|
12212
|
+
# Identifier of the secondary Aurora DB cluster that you want to
|
12213
|
+
# promote to primary for the Aurora global database (GlobalCluster.)
|
12214
|
+
# Use the Amazon Resource Name (ARN) for the identifier so that Aurora
|
12215
|
+
# can locate the cluster in its AWS Region.
|
12216
|
+
# @return [String]
|
12217
|
+
#
|
12218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverGlobalClusterMessage AWS API Documentation
|
12219
|
+
#
|
12220
|
+
class FailoverGlobalClusterMessage < Struct.new(
|
12221
|
+
:global_cluster_identifier,
|
12222
|
+
:target_db_cluster_identifier)
|
12223
|
+
SENSITIVE = []
|
12224
|
+
include Aws::Structure
|
12225
|
+
end
|
12226
|
+
|
12227
|
+
# @!attribute [rw] global_cluster
|
12228
|
+
# A data type representing an Aurora global database.
|
12229
|
+
# @return [Types::GlobalCluster]
|
12230
|
+
#
|
12231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverGlobalClusterResult AWS API Documentation
|
12232
|
+
#
|
12233
|
+
class FailoverGlobalClusterResult < Struct.new(
|
12234
|
+
:global_cluster)
|
12235
|
+
SENSITIVE = []
|
12236
|
+
include Aws::Structure
|
12237
|
+
end
|
12238
|
+
|
12239
|
+
# Contains the state of scheduled or in-process failover operations on
|
12240
|
+
# an Aurora global database (GlobalCluster). This Data type is empty
|
12241
|
+
# unless a failover operation is scheduled or is currently underway on
|
12242
|
+
# the Aurora global database.
|
12243
|
+
#
|
12244
|
+
# @!attribute [rw] status
|
12245
|
+
# The current status of the Aurora global database (GlobalCluster).
|
12246
|
+
# Possible values are as follows:
|
12247
|
+
#
|
12248
|
+
# * pending – A request to fail over the Aurora global database
|
12249
|
+
# (GlobalCluster) has been received by the service. The
|
12250
|
+
# `GlobalCluster`'s primary DB cluster and the specified secondary
|
12251
|
+
# DB cluster are being verified before the failover process can
|
12252
|
+
# start.
|
12253
|
+
#
|
12254
|
+
# * failing-over – This status covers the range of Aurora internal
|
12255
|
+
# operations that take place during the failover process, such as
|
12256
|
+
# demoting the primary Aurora DB cluster, promoting the secondary
|
12257
|
+
# Aurora DB, and synchronizing replicas.
|
12258
|
+
#
|
12259
|
+
# * cancelling – The request to fail over the Aurora global database
|
12260
|
+
# (GlobalCluster) was cancelled and the primary Aurora DB cluster
|
12261
|
+
# and the selected secondary Aurora DB cluster are returning to
|
12262
|
+
# their previous states.
|
12263
|
+
# @return [String]
|
12264
|
+
#
|
12265
|
+
# @!attribute [rw] from_db_cluster_arn
|
12266
|
+
# The Amazon Resource Name (ARN) of the Aurora DB cluster that is
|
12267
|
+
# currently being demoted, and which is associated with this state.
|
12268
|
+
# @return [String]
|
12269
|
+
#
|
12270
|
+
# @!attribute [rw] to_db_cluster_arn
|
12271
|
+
# The Amazon Resource Name (ARN) of the Aurora DB cluster that is
|
12272
|
+
# currently being promoted, and which is associated with this state.
|
12273
|
+
# @return [String]
|
12274
|
+
#
|
12275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverState AWS API Documentation
|
12276
|
+
#
|
12277
|
+
class FailoverState < Struct.new(
|
12278
|
+
:status,
|
12279
|
+
:from_db_cluster_arn,
|
12280
|
+
:to_db_cluster_arn)
|
12281
|
+
SENSITIVE = []
|
12282
|
+
include Aws::Structure
|
12283
|
+
end
|
12284
|
+
|
12181
12285
|
# A filter name and value pair that is used to return a more specific
|
12182
12286
|
# list of results from a describe operation. Filters can be used to
|
12183
12287
|
# match a set of resources by specific criteria, such as IDs. The
|
@@ -12273,6 +12377,14 @@ module Aws::RDS
|
|
12273
12377
|
# database cluster. Currently limited to 1 item.
|
12274
12378
|
# @return [Array<Types::GlobalClusterMember>]
|
12275
12379
|
#
|
12380
|
+
# @!attribute [rw] failover_state
|
12381
|
+
# A data object containing all properties for the current state of an
|
12382
|
+
# in-process or pending failover process for this Aurora global
|
12383
|
+
# database. This object is empty unless the FailoverGlobalCluster API
|
12384
|
+
# operation has been called on this Aurora global database
|
12385
|
+
# (GlobalCluster).
|
12386
|
+
# @return [Types::FailoverState]
|
12387
|
+
#
|
12276
12388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/GlobalCluster AWS API Documentation
|
12277
12389
|
#
|
12278
12390
|
class GlobalCluster < Struct.new(
|
@@ -12285,7 +12397,8 @@ module Aws::RDS
|
|
12285
12397
|
:database_name,
|
12286
12398
|
:storage_encrypted,
|
12287
12399
|
:deletion_protection,
|
12288
|
-
:global_cluster_members
|
12400
|
+
:global_cluster_members,
|
12401
|
+
:failover_state)
|
12289
12402
|
SENSITIVE = []
|
12290
12403
|
include Aws::Structure
|
12291
12404
|
end
|
@@ -13313,12 +13426,19 @@ module Aws::RDS
|
|
13313
13426
|
# @return [Boolean]
|
13314
13427
|
#
|
13315
13428
|
# @!attribute [rw] enable_global_write_forwarding
|
13316
|
-
# A value that indicates whether to enable
|
13317
|
-
#
|
13318
|
-
#
|
13319
|
-
#
|
13320
|
-
#
|
13321
|
-
#
|
13429
|
+
# A value that indicates whether to enable this DB cluster to forward
|
13430
|
+
# write operations to the primary cluster of an Aurora global database
|
13431
|
+
# (GlobalCluster). By default, write operations are not allowed on
|
13432
|
+
# Aurora DB clusters that are secondary clusters in an Aurora global
|
13433
|
+
# database.
|
13434
|
+
#
|
13435
|
+
# You can set this value only on Aurora DB clusters that are members
|
13436
|
+
# of an Aurora global database. With this parameter enabled, a
|
13437
|
+
# secondary cluster can forward writes to the current primary cluster
|
13438
|
+
# and the resulting changes are replicated back to this cluster. For
|
13439
|
+
# the primary DB cluster of an Aurora global database, this value is
|
13440
|
+
# used immediately if the primary is demoted by the
|
13441
|
+
# FailoverGlobalCluster API operation, but it does nothing until then.
|
13322
13442
|
# @return [Boolean]
|
13323
13443
|
#
|
13324
13444
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterMessage AWS API Documentation
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-rds
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.113.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-02-
|
11
|
+
date: 2021-02-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sigv4
|