aws-sdk-docdb 1.30.0 → 1.31.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-docdb.rb +1 -1
- data/lib/aws-sdk-docdb/client.rb +378 -9
- data/lib/aws-sdk-docdb/client_api.rb +162 -2
- data/lib/aws-sdk-docdb/errors.rb +44 -0
- data/lib/aws-sdk-docdb/types.rb +423 -6
- metadata +3 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b0bf10d800e8d42431d3d8e40536c4c1c37c5c7d811b4d33862cf956160d8b40
|
4
|
+
data.tar.gz: 8ef2fa74fba68ea739aa006b47df699923dd21c9517d813c07d35a86cd1877a8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8b09fe0d84e59ca4ef46b3093dfa8c4ab88a21522a8fc79669f6bbe51c62a5328754c19aeeacf83fb05c3b63d492deafc2c52bb7ff7aba0ac3a058dc1c10cfa1
|
7
|
+
data.tar.gz: 744bbaa3e86ee776b13aeffc458c0ae9a1939f1cf2f5b4c87822e25ea8d9072ff4b20d299dc08e6d79751ad5666ca801408daf5aeba1038481375bffb1450318
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.31.0
|
data/lib/aws-sdk-docdb.rb
CHANGED
data/lib/aws-sdk-docdb/client.rb
CHANGED
@@ -775,7 +775,7 @@ module Aws::DocDB
|
|
775
775
|
# The port number on which the instances in the cluster accept
|
776
776
|
# connections.
|
777
777
|
#
|
778
|
-
# @option params [
|
778
|
+
# @option params [String] :master_username
|
779
779
|
# The name of the master user for the cluster.
|
780
780
|
#
|
781
781
|
# Constraints:
|
@@ -786,7 +786,7 @@ module Aws::DocDB
|
|
786
786
|
#
|
787
787
|
# * Cannot be a reserved word for the chosen database engine.
|
788
788
|
#
|
789
|
-
# @option params [
|
789
|
+
# @option params [String] :master_user_password
|
790
790
|
# The password for the master database user. This password can contain
|
791
791
|
# any printable ASCII character except forward slash (/), double quote
|
792
792
|
# ("), or the "at" symbol (@).
|
@@ -871,6 +871,9 @@ module Aws::DocDB
|
|
871
871
|
# `DeletionProtection` is disabled. `DeletionProtection` protects
|
872
872
|
# clusters from being accidentally deleted.
|
873
873
|
#
|
874
|
+
# @option params [String] :global_cluster_identifier
|
875
|
+
# The cluster identifier of the new global cluster.
|
876
|
+
#
|
874
877
|
# @option params [String] :source_region
|
875
878
|
# The source region of the snapshot. This is only needed when the
|
876
879
|
# shapshot is encrypted and in a different region.
|
@@ -891,8 +894,8 @@ module Aws::DocDB
|
|
891
894
|
# engine: "String", # required
|
892
895
|
# engine_version: "String",
|
893
896
|
# port: 1,
|
894
|
-
# master_username: "String",
|
895
|
-
# master_user_password: "String",
|
897
|
+
# master_username: "String",
|
898
|
+
# master_user_password: "String",
|
896
899
|
# preferred_backup_window: "String",
|
897
900
|
# preferred_maintenance_window: "String",
|
898
901
|
# tags: [
|
@@ -906,6 +909,7 @@ module Aws::DocDB
|
|
906
909
|
# pre_signed_url: "String",
|
907
910
|
# enable_cloudwatch_logs_exports: ["String"],
|
908
911
|
# deletion_protection: false,
|
912
|
+
# global_cluster_identifier: "GlobalClusterIdentifier",
|
909
913
|
# source_region: "String",
|
910
914
|
# })
|
911
915
|
#
|
@@ -930,6 +934,9 @@ module Aws::DocDB
|
|
930
934
|
# resp.db_cluster.master_username #=> String
|
931
935
|
# resp.db_cluster.preferred_backup_window #=> String
|
932
936
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
937
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
938
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
939
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
933
940
|
# resp.db_cluster.db_cluster_members #=> Array
|
934
941
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
935
942
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -1464,6 +1471,91 @@ module Aws::DocDB
|
|
1464
1471
|
req.send_request(options)
|
1465
1472
|
end
|
1466
1473
|
|
1474
|
+
# Creates an Amazon DocumentDB global cluster that can span multiple
|
1475
|
+
# multiple AWS Regions. The global cluster contains one primary cluster
|
1476
|
+
# with read-write capability, and up-to give read-only secondary
|
1477
|
+
# clusters. Global clusters uses storage-based fast replication across
|
1478
|
+
# regions with latencies less than one second, using dedicated
|
1479
|
+
# infrastructure with no impact to your workload’s performance.
|
1480
|
+
#
|
1481
|
+
#
|
1482
|
+
#
|
1483
|
+
# You can create a global cluster that is initially empty, and then add
|
1484
|
+
# a primary and a secondary to it. Or you can specify an existing
|
1485
|
+
# cluster during the create operation, and this cluster becomes the
|
1486
|
+
# primary of the global cluster.
|
1487
|
+
#
|
1488
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
1489
|
+
#
|
1490
|
+
# </note>
|
1491
|
+
#
|
1492
|
+
# @option params [required, String] :global_cluster_identifier
|
1493
|
+
# The cluster identifier of the new global cluster.
|
1494
|
+
#
|
1495
|
+
# @option params [String] :source_db_cluster_identifier
|
1496
|
+
# The Amazon Resource Name (ARN) to use as the primary cluster of the
|
1497
|
+
# global cluster. This parameter is optional.
|
1498
|
+
#
|
1499
|
+
# @option params [String] :engine
|
1500
|
+
# The name of the database engine to be used for this cluster.
|
1501
|
+
#
|
1502
|
+
# @option params [String] :engine_version
|
1503
|
+
# The engine version of the global cluster.
|
1504
|
+
#
|
1505
|
+
# @option params [Boolean] :deletion_protection
|
1506
|
+
# The deletion protection setting for the new global cluster. The global
|
1507
|
+
# cluster can't be deleted when deletion protection is enabled.
|
1508
|
+
#
|
1509
|
+
# @option params [String] :database_name
|
1510
|
+
# The name for your database of up to 64 alpha-numeric characters. If
|
1511
|
+
# you do not provide a name, Amazon DocumentDB will not create a
|
1512
|
+
# database in the global cluster you are creating.
|
1513
|
+
#
|
1514
|
+
# @option params [Boolean] :storage_encrypted
|
1515
|
+
# The storage encryption setting for the new global cluster.
|
1516
|
+
#
|
1517
|
+
# @return [Types::CreateGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1518
|
+
#
|
1519
|
+
# * {Types::CreateGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
1520
|
+
#
|
1521
|
+
# @example Request syntax with placeholder values
|
1522
|
+
#
|
1523
|
+
# resp = client.create_global_cluster({
|
1524
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
1525
|
+
# source_db_cluster_identifier: "String",
|
1526
|
+
# engine: "String",
|
1527
|
+
# engine_version: "String",
|
1528
|
+
# deletion_protection: false,
|
1529
|
+
# database_name: "String",
|
1530
|
+
# storage_encrypted: false,
|
1531
|
+
# })
|
1532
|
+
#
|
1533
|
+
# @example Response structure
|
1534
|
+
#
|
1535
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
1536
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
1537
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
1538
|
+
# resp.global_cluster.status #=> String
|
1539
|
+
# resp.global_cluster.engine #=> String
|
1540
|
+
# resp.global_cluster.engine_version #=> String
|
1541
|
+
# resp.global_cluster.database_name #=> String
|
1542
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
1543
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
1544
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
1545
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
1546
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
1547
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
1548
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
1549
|
+
#
|
1550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateGlobalCluster AWS API Documentation
|
1551
|
+
#
|
1552
|
+
# @overload create_global_cluster(params = {})
|
1553
|
+
# @param [Hash] params ({})
|
1554
|
+
def create_global_cluster(params = {}, options = {})
|
1555
|
+
req = build_request(:create_global_cluster, params)
|
1556
|
+
req.send_request(options)
|
1557
|
+
end
|
1558
|
+
|
1467
1559
|
# Deletes a previously provisioned cluster. When you delete a cluster,
|
1468
1560
|
# all automated backups for that cluster are deleted and can't be
|
1469
1561
|
# recovered. Manual DB cluster snapshots of the specified cluster are
|
@@ -1542,6 +1634,9 @@ module Aws::DocDB
|
|
1542
1634
|
# resp.db_cluster.master_username #=> String
|
1543
1635
|
# resp.db_cluster.preferred_backup_window #=> String
|
1544
1636
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
1637
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
1638
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
1639
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
1545
1640
|
# resp.db_cluster.db_cluster_members #=> Array
|
1546
1641
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
1547
1642
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -1827,6 +1922,53 @@ module Aws::DocDB
|
|
1827
1922
|
req.send_request(options)
|
1828
1923
|
end
|
1829
1924
|
|
1925
|
+
# Deletes a global cluster. The primary and secondary clusters must
|
1926
|
+
# already be detached or deleted before attempting to delete a global
|
1927
|
+
# cluster.
|
1928
|
+
#
|
1929
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
1930
|
+
#
|
1931
|
+
# </note>
|
1932
|
+
#
|
1933
|
+
# @option params [required, String] :global_cluster_identifier
|
1934
|
+
# The cluster identifier of the global cluster being deleted.
|
1935
|
+
#
|
1936
|
+
# @return [Types::DeleteGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1937
|
+
#
|
1938
|
+
# * {Types::DeleteGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
1939
|
+
#
|
1940
|
+
# @example Request syntax with placeholder values
|
1941
|
+
#
|
1942
|
+
# resp = client.delete_global_cluster({
|
1943
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
1944
|
+
# })
|
1945
|
+
#
|
1946
|
+
# @example Response structure
|
1947
|
+
#
|
1948
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
1949
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
1950
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
1951
|
+
# resp.global_cluster.status #=> String
|
1952
|
+
# resp.global_cluster.engine #=> String
|
1953
|
+
# resp.global_cluster.engine_version #=> String
|
1954
|
+
# resp.global_cluster.database_name #=> String
|
1955
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
1956
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
1957
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
1958
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
1959
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
1960
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
1961
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
1962
|
+
#
|
1963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteGlobalCluster AWS API Documentation
|
1964
|
+
#
|
1965
|
+
# @overload delete_global_cluster(params = {})
|
1966
|
+
# @param [Hash] params ({})
|
1967
|
+
def delete_global_cluster(params = {}, options = {})
|
1968
|
+
req = build_request(:delete_global_cluster, params)
|
1969
|
+
req.send_request(options)
|
1970
|
+
end
|
1971
|
+
|
1830
1972
|
# Returns a list of certificate authority (CA) certificates provided by
|
1831
1973
|
# Amazon DocumentDB for this AWS account.
|
1832
1974
|
#
|
@@ -2148,7 +2290,7 @@ module Aws::DocDB
|
|
2148
2290
|
# manual cluster snapshots are returned. You can include shared cluster
|
2149
2291
|
# snapshots with these results by setting the `IncludeShared` parameter
|
2150
2292
|
# to `true`. You can include public cluster snapshots with these results
|
2151
|
-
# by setting the
|
2293
|
+
# by setting the`IncludePublic` parameter to `true`.
|
2152
2294
|
#
|
2153
2295
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
2154
2296
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -2329,6 +2471,9 @@ module Aws::DocDB
|
|
2329
2471
|
# resp.db_clusters[0].master_username #=> String
|
2330
2472
|
# resp.db_clusters[0].preferred_backup_window #=> String
|
2331
2473
|
# resp.db_clusters[0].preferred_maintenance_window #=> String
|
2474
|
+
# resp.db_clusters[0].replication_source_identifier #=> String
|
2475
|
+
# resp.db_clusters[0].read_replica_identifiers #=> Array
|
2476
|
+
# resp.db_clusters[0].read_replica_identifiers[0] #=> String
|
2332
2477
|
# resp.db_clusters[0].db_cluster_members #=> Array
|
2333
2478
|
# resp.db_clusters[0].db_cluster_members[0].db_instance_identifier #=> String
|
2334
2479
|
# resp.db_clusters[0].db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -2984,6 +3129,86 @@ module Aws::DocDB
|
|
2984
3129
|
req.send_request(options)
|
2985
3130
|
end
|
2986
3131
|
|
3132
|
+
# Returns information about Amazon DocumentDB global clusters. This API
|
3133
|
+
# supports pagination.
|
3134
|
+
#
|
3135
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
3136
|
+
#
|
3137
|
+
# </note>
|
3138
|
+
#
|
3139
|
+
# @option params [String] :global_cluster_identifier
|
3140
|
+
# The user-supplied cluster identifier. If this parameter is specified,
|
3141
|
+
# information from only the specific cluster is returned. This parameter
|
3142
|
+
# isn't case-sensitive.
|
3143
|
+
#
|
3144
|
+
# @option params [Array<Types::Filter>] :filters
|
3145
|
+
# A filter that specifies one or more global DB clusters to describe.
|
3146
|
+
#
|
3147
|
+
# Supported filters: `db-cluster-id` accepts cluster identifiers and
|
3148
|
+
# cluster Amazon Resource Names (ARNs). The results list will only
|
3149
|
+
# include information about the clusters identified by these ARNs.
|
3150
|
+
#
|
3151
|
+
# @option params [Integer] :max_records
|
3152
|
+
# The maximum number of records to include in the response. If more
|
3153
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
3154
|
+
# token called a marker is included in the response so that you can
|
3155
|
+
# retrieve the remaining results.
|
3156
|
+
#
|
3157
|
+
# @option params [String] :marker
|
3158
|
+
# An optional pagination token provided by a previous
|
3159
|
+
# `DescribeGlobalClusters` request. If this parameter is specified, the
|
3160
|
+
# response includes only records beyond the marker, up to the value
|
3161
|
+
# specified by `MaxRecords`.
|
3162
|
+
#
|
3163
|
+
# @return [Types::GlobalClustersMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3164
|
+
#
|
3165
|
+
# * {Types::GlobalClustersMessage#marker #marker} => String
|
3166
|
+
# * {Types::GlobalClustersMessage#global_clusters #global_clusters} => Array<Types::GlobalCluster>
|
3167
|
+
#
|
3168
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3169
|
+
#
|
3170
|
+
# @example Request syntax with placeholder values
|
3171
|
+
#
|
3172
|
+
# resp = client.describe_global_clusters({
|
3173
|
+
# global_cluster_identifier: "GlobalClusterIdentifier",
|
3174
|
+
# filters: [
|
3175
|
+
# {
|
3176
|
+
# name: "String", # required
|
3177
|
+
# values: ["String"], # required
|
3178
|
+
# },
|
3179
|
+
# ],
|
3180
|
+
# max_records: 1,
|
3181
|
+
# marker: "String",
|
3182
|
+
# })
|
3183
|
+
#
|
3184
|
+
# @example Response structure
|
3185
|
+
#
|
3186
|
+
# resp.marker #=> String
|
3187
|
+
# resp.global_clusters #=> Array
|
3188
|
+
# resp.global_clusters[0].global_cluster_identifier #=> String
|
3189
|
+
# resp.global_clusters[0].global_cluster_resource_id #=> String
|
3190
|
+
# resp.global_clusters[0].global_cluster_arn #=> String
|
3191
|
+
# resp.global_clusters[0].status #=> String
|
3192
|
+
# resp.global_clusters[0].engine #=> String
|
3193
|
+
# resp.global_clusters[0].engine_version #=> String
|
3194
|
+
# resp.global_clusters[0].database_name #=> String
|
3195
|
+
# resp.global_clusters[0].storage_encrypted #=> Boolean
|
3196
|
+
# resp.global_clusters[0].deletion_protection #=> Boolean
|
3197
|
+
# resp.global_clusters[0].global_cluster_members #=> Array
|
3198
|
+
# resp.global_clusters[0].global_cluster_members[0].db_cluster_arn #=> String
|
3199
|
+
# resp.global_clusters[0].global_cluster_members[0].readers #=> Array
|
3200
|
+
# resp.global_clusters[0].global_cluster_members[0].readers[0] #=> String
|
3201
|
+
# resp.global_clusters[0].global_cluster_members[0].is_writer #=> Boolean
|
3202
|
+
#
|
3203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeGlobalClusters AWS API Documentation
|
3204
|
+
#
|
3205
|
+
# @overload describe_global_clusters(params = {})
|
3206
|
+
# @param [Hash] params ({})
|
3207
|
+
def describe_global_clusters(params = {}, options = {})
|
3208
|
+
req = build_request(:describe_global_clusters, params)
|
3209
|
+
req.send_request(options)
|
3210
|
+
end
|
3211
|
+
|
2987
3212
|
# Returns a list of orderable instance options for the specified engine.
|
2988
3213
|
#
|
2989
3214
|
# @option params [required, String] :engine
|
@@ -3206,6 +3431,9 @@ module Aws::DocDB
|
|
3206
3431
|
# resp.db_cluster.master_username #=> String
|
3207
3432
|
# resp.db_cluster.preferred_backup_window #=> String
|
3208
3433
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
3434
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
3435
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
3436
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
3209
3437
|
# resp.db_cluster.db_cluster_members #=> Array
|
3210
3438
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
3211
3439
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -3394,9 +3622,8 @@ module Aws::DocDB
|
|
3394
3622
|
#
|
3395
3623
|
# @option params [String] :engine_version
|
3396
3624
|
# The version number of the database engine to which you want to
|
3397
|
-
# upgrade.
|
3398
|
-
#
|
3399
|
-
# `ApplyImmediately` parameter is set to `true`.
|
3625
|
+
# upgrade. Modifying engine version is not supported on Amazon
|
3626
|
+
# DocumentDB.
|
3400
3627
|
#
|
3401
3628
|
# @option params [Boolean] :deletion_protection
|
3402
3629
|
# Specifies whether this cluster can be deleted. If `DeletionProtection`
|
@@ -3450,6 +3677,9 @@ module Aws::DocDB
|
|
3450
3677
|
# resp.db_cluster.master_username #=> String
|
3451
3678
|
# resp.db_cluster.preferred_backup_window #=> String
|
3452
3679
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
3680
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
3681
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
3682
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
3453
3683
|
# resp.db_cluster.db_cluster_members #=> Array
|
3454
3684
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
3455
3685
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -3918,6 +4148,79 @@ module Aws::DocDB
|
|
3918
4148
|
req.send_request(options)
|
3919
4149
|
end
|
3920
4150
|
|
4151
|
+
# Modify a setting for an Amazon DocumentDB global cluster. You can
|
4152
|
+
# change one or more configuration parameters (for example: deletion
|
4153
|
+
# protection), or the global cluster identifier by specifying these
|
4154
|
+
# parameters and the new values in the request.
|
4155
|
+
#
|
4156
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
4157
|
+
#
|
4158
|
+
# </note>
|
4159
|
+
#
|
4160
|
+
# @option params [required, String] :global_cluster_identifier
|
4161
|
+
# The identifier for the global cluster being modified. This parameter
|
4162
|
+
# isn't case-sensitive.
|
4163
|
+
#
|
4164
|
+
# Constraints:
|
4165
|
+
#
|
4166
|
+
# * Must match the identifier of an existing global cluster.
|
4167
|
+
#
|
4168
|
+
# ^
|
4169
|
+
#
|
4170
|
+
# @option params [String] :new_global_cluster_identifier
|
4171
|
+
# The new identifier for a global cluster when you modify a global
|
4172
|
+
# cluster. This value is stored as a lowercase string.
|
4173
|
+
#
|
4174
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
4175
|
+
#
|
4176
|
+
# The first character must be a letter
|
4177
|
+
#
|
4178
|
+
# Can't end with a hyphen or contain two consecutive hyphens
|
4179
|
+
#
|
4180
|
+
# Example: `my-cluster2`
|
4181
|
+
#
|
4182
|
+
# @option params [Boolean] :deletion_protection
|
4183
|
+
# Indicates if the global cluster has deletion protection enabled. The
|
4184
|
+
# global cluster can't be deleted when deletion protection is enabled.
|
4185
|
+
#
|
4186
|
+
# @return [Types::ModifyGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4187
|
+
#
|
4188
|
+
# * {Types::ModifyGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
4189
|
+
#
|
4190
|
+
# @example Request syntax with placeholder values
|
4191
|
+
#
|
4192
|
+
# resp = client.modify_global_cluster({
|
4193
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
4194
|
+
# new_global_cluster_identifier: "GlobalClusterIdentifier",
|
4195
|
+
# deletion_protection: false,
|
4196
|
+
# })
|
4197
|
+
#
|
4198
|
+
# @example Response structure
|
4199
|
+
#
|
4200
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
4201
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
4202
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
4203
|
+
# resp.global_cluster.status #=> String
|
4204
|
+
# resp.global_cluster.engine #=> String
|
4205
|
+
# resp.global_cluster.engine_version #=> String
|
4206
|
+
# resp.global_cluster.database_name #=> String
|
4207
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
4208
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
4209
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
4210
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
4211
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
4212
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
4213
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
4214
|
+
#
|
4215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyGlobalCluster AWS API Documentation
|
4216
|
+
#
|
4217
|
+
# @overload modify_global_cluster(params = {})
|
4218
|
+
# @param [Hash] params ({})
|
4219
|
+
def modify_global_cluster(params = {}, options = {})
|
4220
|
+
req = build_request(:modify_global_cluster, params)
|
4221
|
+
req.send_request(options)
|
4222
|
+
end
|
4223
|
+
|
3921
4224
|
# You might need to reboot your instance, usually for maintenance
|
3922
4225
|
# reasons. For example, if you make certain changes, or if you change
|
3923
4226
|
# the cluster parameter group that is associated with the instance, you
|
@@ -4025,6 +4328,60 @@ module Aws::DocDB
|
|
4025
4328
|
req.send_request(options)
|
4026
4329
|
end
|
4027
4330
|
|
4331
|
+
# Detaches an Amazon DocumentDB secondary cluster from a global cluster.
|
4332
|
+
# The cluster becomes a standalone cluster with read-write capability
|
4333
|
+
# instead of being read-only and receiving data from a primary in a
|
4334
|
+
# different region.
|
4335
|
+
#
|
4336
|
+
# <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
|
4337
|
+
#
|
4338
|
+
# </note>
|
4339
|
+
#
|
4340
|
+
# @option params [required, String] :global_cluster_identifier
|
4341
|
+
# The cluster identifier to detach from the Amazon DocumentDB global
|
4342
|
+
# cluster.
|
4343
|
+
#
|
4344
|
+
# @option params [required, String] :db_cluster_identifier
|
4345
|
+
# The Amazon Resource Name (ARN) identifying the cluster that was
|
4346
|
+
# detached from the Amazon DocumentDB global cluster.
|
4347
|
+
#
|
4348
|
+
# @return [Types::RemoveFromGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4349
|
+
#
|
4350
|
+
# * {Types::RemoveFromGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
|
4351
|
+
#
|
4352
|
+
# @example Request syntax with placeholder values
|
4353
|
+
#
|
4354
|
+
# resp = client.remove_from_global_cluster({
|
4355
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
4356
|
+
# db_cluster_identifier: "String", # required
|
4357
|
+
# })
|
4358
|
+
#
|
4359
|
+
# @example Response structure
|
4360
|
+
#
|
4361
|
+
# resp.global_cluster.global_cluster_identifier #=> String
|
4362
|
+
# resp.global_cluster.global_cluster_resource_id #=> String
|
4363
|
+
# resp.global_cluster.global_cluster_arn #=> String
|
4364
|
+
# resp.global_cluster.status #=> String
|
4365
|
+
# resp.global_cluster.engine #=> String
|
4366
|
+
# resp.global_cluster.engine_version #=> String
|
4367
|
+
# resp.global_cluster.database_name #=> String
|
4368
|
+
# resp.global_cluster.storage_encrypted #=> Boolean
|
4369
|
+
# resp.global_cluster.deletion_protection #=> Boolean
|
4370
|
+
# resp.global_cluster.global_cluster_members #=> Array
|
4371
|
+
# resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
|
4372
|
+
# resp.global_cluster.global_cluster_members[0].readers #=> Array
|
4373
|
+
# resp.global_cluster.global_cluster_members[0].readers[0] #=> String
|
4374
|
+
# resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
|
4375
|
+
#
|
4376
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveFromGlobalCluster AWS API Documentation
|
4377
|
+
#
|
4378
|
+
# @overload remove_from_global_cluster(params = {})
|
4379
|
+
# @param [Hash] params ({})
|
4380
|
+
def remove_from_global_cluster(params = {}, options = {})
|
4381
|
+
req = build_request(:remove_from_global_cluster, params)
|
4382
|
+
req.send_request(options)
|
4383
|
+
end
|
4384
|
+
|
4028
4385
|
# Removes a source identifier from an existing Amazon DocumentDB event
|
4029
4386
|
# notification subscription.
|
4030
4387
|
#
|
@@ -4311,6 +4668,9 @@ module Aws::DocDB
|
|
4311
4668
|
# resp.db_cluster.master_username #=> String
|
4312
4669
|
# resp.db_cluster.preferred_backup_window #=> String
|
4313
4670
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
4671
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
4672
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
4673
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
4314
4674
|
# resp.db_cluster.db_cluster_members #=> Array
|
4315
4675
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
4316
4676
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -4501,6 +4861,9 @@ module Aws::DocDB
|
|
4501
4861
|
# resp.db_cluster.master_username #=> String
|
4502
4862
|
# resp.db_cluster.preferred_backup_window #=> String
|
4503
4863
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
4864
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
4865
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
4866
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
4504
4867
|
# resp.db_cluster.db_cluster_members #=> Array
|
4505
4868
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
4506
4869
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -4574,6 +4937,9 @@ module Aws::DocDB
|
|
4574
4937
|
# resp.db_cluster.master_username #=> String
|
4575
4938
|
# resp.db_cluster.preferred_backup_window #=> String
|
4576
4939
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
4940
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
4941
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
4942
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
4577
4943
|
# resp.db_cluster.db_cluster_members #=> Array
|
4578
4944
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
4579
4945
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -4647,6 +5013,9 @@ module Aws::DocDB
|
|
4647
5013
|
# resp.db_cluster.master_username #=> String
|
4648
5014
|
# resp.db_cluster.preferred_backup_window #=> String
|
4649
5015
|
# resp.db_cluster.preferred_maintenance_window #=> String
|
5016
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
5017
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
5018
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
4650
5019
|
# resp.db_cluster.db_cluster_members #=> Array
|
4651
5020
|
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
4652
5021
|
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
@@ -4690,7 +5059,7 @@ module Aws::DocDB
|
|
4690
5059
|
params: params,
|
4691
5060
|
config: config)
|
4692
5061
|
context[:gem_name] = 'aws-sdk-docdb'
|
4693
|
-
context[:gem_version] = '1.
|
5062
|
+
context[:gem_version] = '1.31.0'
|
4694
5063
|
Seahorse::Client::Request.new(handlers, context)
|
4695
5064
|
end
|
4696
5065
|
|