aws-sdk-docdb 1.30.0 → 1.34.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ef51d22dcd47b94c5fade5a5dfe4ce3e4d7d4585078bc7b80152e674a5a9eb7c
4
- data.tar.gz: 12389a846a9044e80cd07ff2026196558219f625f485cfb4122d31e5aa0fe31a
3
+ metadata.gz: 569949264820a0402ad1faa4f2cc1125b0a2757bc9fb15c33dd49752aa44b0a6
4
+ data.tar.gz: c4b8b662005871bcb963907c9ae8534825fe7fe3c4541a9d4459abb20979a0ec
5
5
  SHA512:
6
- metadata.gz: 3196274150d93474fa61a2a814f5a495e503abc2272f6c2e48a6ec2a9c37de3b7b19d96cc59e29b01b6e64e9f824a35730394ecd7300d7676189aa409ada3fe1
7
- data.tar.gz: b13aaf10d58211ba700adbc917e62f149aef202d47ca38c5a3e2bedd4dbc0f9d7a9efadd6f6be37936fb6cbbbffa1e3f911df8aecb99abe238cf70e81d8fbe3c
6
+ metadata.gz: e955d37b3bdb70fe3d9dda7f85f4058d2aca9d1ca1fd0d32b295c66d6ef4572a2fbc7e8cdf2d4f731f23004d470e81d5931e78ca6f7c2c8bb7d1547edbc4dcb5
7
+ data.tar.gz: e24684c59acf2a93f2b6243fe1afba3472290f161de042c434f682b575228809b7d902aa4fa882d47f2b7a810b5700bdc7dac45c5393d30260620d15dafdf190
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.34.0 (2021-07-30)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.33.0 (2021-07-28)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
14
+ 1.32.0 (2021-06-23)
15
+ ------------------
16
+
17
+ * Feature - DocumentDB documentation-only edits
18
+
19
+ 1.31.0 (2021-06-02)
20
+ ------------------
21
+
22
+ * Feature - This SDK release adds support for DocDB global clusters.
23
+
4
24
  1.30.0 (2021-03-29)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.30.0
1
+ 1.34.0
data/lib/aws-sdk-docdb.rb CHANGED
@@ -49,6 +49,6 @@ require_relative 'aws-sdk-docdb/customizations'
49
49
  # @!group service
50
50
  module Aws::DocDB
51
51
 
52
- GEM_VERSION = '1.30.0'
52
+ GEM_VERSION = '1.34.0'
53
53
 
54
54
  end
@@ -388,8 +388,8 @@ module Aws::DocDB
388
388
 
389
389
  # Adds metadata tags to an Amazon DocumentDB resource. You can use these
390
390
  # tags with cost allocation reporting to track costs that are associated
391
- # with Amazon DocumentDB resources. or in a `Condition` statement in an
392
- # AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.
391
+ # with Amazon DocumentDB resources or in a `Condition` statement in an
392
+ # Identity and Access Management (IAM) policy for Amazon DocumentDB.
393
393
  #
394
394
  # @option params [required, String] :resource_name
395
395
  # The Amazon DocumentDB resource that the tags are added to. This value
@@ -489,11 +489,11 @@ module Aws::DocDB
489
489
  #
490
490
  # * Must specify a valid cluster parameter group.
491
491
  #
492
- # * If the source cluster parameter group is in the same AWS Region as
493
- # the copy, specify a valid parameter group identifier; for example,
492
+ # * If the source cluster parameter group is in the same Region as the
493
+ # copy, specify a valid parameter group identifier; for example,
494
494
  # `my-db-cluster-param-group`, or a valid ARN.
495
495
  #
496
- # * If the source parameter group is in a different AWS Region than the
496
+ # * If the source parameter group is in a different Region than the
497
497
  # copy, specify a valid cluster parameter group ARN; for example,
498
498
  # `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
499
499
  #
@@ -557,7 +557,7 @@ module Aws::DocDB
557
557
  # To copy a cluster snapshot from a shared manual cluster snapshot,
558
558
  # `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
559
559
  # (ARN) of the shared cluster snapshot. You can only copy a shared DB
560
- # cluster snapshot, whether encrypted or not, in the same AWS Region.
560
+ # cluster snapshot, whether encrypted or not, in the same Region.
561
561
  #
562
562
  # To cancel the copy operation after it is in progress, delete the
563
563
  # target cluster snapshot identified by
@@ -572,10 +572,10 @@ module Aws::DocDB
572
572
  #
573
573
  # * Must specify a valid system snapshot in the *available* state.
574
574
  #
575
- # * If the source snapshot is in the same AWS Region as the copy,
576
- # specify a valid snapshot identifier.
575
+ # * If the source snapshot is in the same Region as the copy, specify a
576
+ # valid snapshot identifier.
577
577
  #
578
- # * If the source snapshot is in a different AWS Region than the copy,
578
+ # * If the source snapshot is in a different Region than the copy,
579
579
  # specify a valid cluster snapshot ARN.
580
580
  #
581
581
  # Example: `my-cluster-snapshot1`
@@ -595,54 +595,53 @@ module Aws::DocDB
595
595
  # Example: `my-cluster-snapshot2`
596
596
  #
597
597
  # @option params [String] :kms_key_id
598
- # The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key
599
- # ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the
600
- # AWS KMS key alias for the AWS KMS encryption key.
598
+ # The KMS key ID for an encrypted cluster snapshot. The KMS key ID is
599
+ # the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
600
+ # alias for the KMS encryption key.
601
601
  #
602
- # If you copy an encrypted cluster snapshot from your AWS account, you
603
- # can specify a value for `KmsKeyId` to encrypt the copy with a new AWS
604
- # KMS encryption key. If you don't specify a value for `KmsKeyId`, then
605
- # the copy of the cluster snapshot is encrypted with the same AWS KMS
606
- # key as the source cluster snapshot.
602
+ # If you copy an encrypted cluster snapshot from your account, you can
603
+ # specify a value for `KmsKeyId` to encrypt the copy with a new KMS
604
+ # encryption key. If you don't specify a value for `KmsKeyId`, then the
605
+ # copy of the cluster snapshot is encrypted with the same KMS key as the
606
+ # source cluster snapshot.
607
607
  #
608
608
  # If you copy an encrypted cluster snapshot that is shared from another
609
- # AWS account, then you must specify a value for `KmsKeyId`.
609
+ # account, then you must specify a value for `KmsKeyId`.
610
610
  #
611
- # To copy an encrypted cluster snapshot to another AWS Region, set
612
- # `KmsKeyId` to the AWS KMS key ID that you want to use to encrypt the
613
- # copy of the cluster snapshot in the destination Region. AWS KMS
614
- # encryption keys are specific to the AWS Region that they are created
615
- # in, and you can't use encryption keys from one AWS Region in another
616
- # AWS Region.
611
+ # To copy an encrypted cluster snapshot to another Region, set
612
+ # `KmsKeyId` to the KMS key ID that you want to use to encrypt the copy
613
+ # of the cluster snapshot in the destination Region. KMS encryption keys
614
+ # are specific to the Region that they are created in, and you can't
615
+ # use encryption keys from one Region in another Region.
617
616
  #
618
617
  # If you copy an unencrypted cluster snapshot and specify a value for
619
618
  # the `KmsKeyId` parameter, an error is returned.
620
619
  #
621
620
  # @option params [String] :pre_signed_url
622
- # The URL that contains a Signature Version 4 signed request for the
623
- # `CopyDBClusterSnapshot` API action in the AWS Region that contains the
621
+ # The URL that contains a Signature Version 4 signed request for
622
+ # the`CopyDBClusterSnapshot` API action in the Region that contains the
624
623
  # source cluster snapshot to copy. You must use the `PreSignedUrl`
625
- # parameter when copying a cluster snapshot from another AWS Region.
624
+ # parameter when copying a cluster snapshot from another Region.
626
625
  #
627
- # If you are using an AWS SDK tool or the AWS CLI, you can specify
628
- # `SourceRegion` (or `--source-region` for the AWS CLI) instead of
626
+ # If you are using an Amazon Web Services SDK tool or the CLI, you can
627
+ # specify `SourceRegion` (or `--source-region` for the CLI) instead of
629
628
  # specifying `PreSignedUrl` manually. Specifying `SourceRegion`
630
629
  # autogenerates a pre-signed URL that is a valid request for the
631
- # operation that can be executed in the source AWS Region.
630
+ # operation that can be executed in the source Region.
632
631
  #
633
632
  # The presigned URL must be a valid request for the
634
633
  # `CopyDBClusterSnapshot` API action that can be executed in the source
635
- # AWS Region that contains the cluster snapshot to be copied. The
636
- # presigned URL request must contain the following parameter values:
634
+ # Region that contains the cluster snapshot to be copied. The presigned
635
+ # URL request must contain the following parameter values:
637
636
  #
638
637
  # * `SourceRegion` - The ID of the region that contains the snapshot to
639
638
  # be copied.
640
639
  #
641
640
  # * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
642
641
  # encrypted cluster snapshot to be copied. This identifier must be in
643
- # the Amazon Resource Name (ARN) format for the source AWS Region. For
642
+ # the Amazon Resource Name (ARN) format for the source Region. For
644
643
  # example, if you are copying an encrypted cluster snapshot from the
645
- # us-east-1 AWS Region, then your `SourceDBClusterSnapshotIdentifier`
644
+ # us-east-1 Region, then your `SourceDBClusterSnapshotIdentifier`
646
645
  # looks something like the following:
647
646
  # `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
648
647
  #
@@ -766,16 +765,16 @@ module Aws::DocDB
766
765
  # Valid values: `docdb`
767
766
  #
768
767
  # @option params [String] :engine_version
769
- # The version number of the database engine to use. The --engine-version
770
- # will default to the latest major engine version. For production
771
- # workloads, we recommend explicitly declaring this parameter with the
772
- # intended major engine version.
768
+ # The version number of the database engine to use. The
769
+ # `--engine-version` will default to the latest major engine version.
770
+ # For production workloads, we recommend explicitly declaring this
771
+ # parameter with the intended major engine version.
773
772
  #
774
773
  # @option params [Integer] :port
775
774
  # The port number on which the instances in the cluster accept
776
775
  # connections.
777
776
  #
778
- # @option params [required, String] :master_username
777
+ # @option params [String] :master_username
779
778
  # The name of the master user for the cluster.
780
779
  #
781
780
  # Constraints:
@@ -786,7 +785,7 @@ module Aws::DocDB
786
785
  #
787
786
  # * Cannot be a reserved word for the chosen database engine.
788
787
  #
789
- # @option params [required, String] :master_user_password
788
+ # @option params [String] :master_user_password
790
789
  # The password for the master database user. This password can contain
791
790
  # any printable ASCII character except forward slash (/), double quote
792
791
  # ("), or the "at" symbol (@).
@@ -799,7 +798,7 @@ module Aws::DocDB
799
798
  # parameter.
800
799
  #
801
800
  # The default is a 30-minute window selected at random from an 8-hour
802
- # block of time for each AWS Region.
801
+ # block of time for each Region.
803
802
  #
804
803
  # Constraints:
805
804
  #
@@ -818,8 +817,7 @@ module Aws::DocDB
818
817
  # Format: `ddd:hh24:mi-ddd:hh24:mi`
819
818
  #
820
819
  # The default is a 30-minute window selected at random from an 8-hour
821
- # block of time for each AWS Region, occurring on a random day of the
822
- # week.
820
+ # block of time for each Region, occurring on a random day of the week.
823
821
  #
824
822
  # Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
825
823
  #
@@ -832,13 +830,13 @@ module Aws::DocDB
832
830
  # Specifies whether the cluster is encrypted.
833
831
  #
834
832
  # @option params [String] :kms_key_id
835
- # The AWS KMS key identifier for an encrypted cluster.
833
+ # The KMS key identifier for an encrypted cluster.
836
834
  #
837
- # The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
838
- # AWS KMS encryption key. If you are creating a cluster using the same
839
- # AWS account that owns the AWS KMS encryption key that is used to
840
- # encrypt the new cluster, you can use the AWS KMS key alias instead of
841
- # the ARN for the AWS KMS encryption key.
835
+ # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
836
+ # encryption key. If you are creating a cluster using the same account
837
+ # that owns the KMS encryption key that is used to encrypt the new
838
+ # cluster, you can use the KMS key alias instead of the ARN for the KMS
839
+ # encryption key.
842
840
  #
843
841
  # If an encryption key is not specified in `KmsKeyId`\:
844
842
  #
@@ -847,9 +845,8 @@ module Aws::DocDB
847
845
  #
848
846
  # ^
849
847
  #
850
- # AWS KMS creates the default encryption key for your AWS account. Your
851
- # AWS account has a different default encryption key for each AWS
852
- # Region.
848
+ # KMS creates the default encryption key for your account. Your account
849
+ # has a different default encryption key for each Regions.
853
850
  #
854
851
  # @option params [String] :pre_signed_url
855
852
  # Not currently supported.
@@ -871,6 +868,9 @@ module Aws::DocDB
871
868
  # `DeletionProtection` is disabled. `DeletionProtection` protects
872
869
  # clusters from being accidentally deleted.
873
870
  #
871
+ # @option params [String] :global_cluster_identifier
872
+ # The cluster identifier of the new global cluster.
873
+ #
874
874
  # @option params [String] :source_region
875
875
  # The source region of the snapshot. This is only needed when the
876
876
  # shapshot is encrypted and in a different region.
@@ -891,8 +891,8 @@ module Aws::DocDB
891
891
  # engine: "String", # required
892
892
  # engine_version: "String",
893
893
  # port: 1,
894
- # master_username: "String", # required
895
- # master_user_password: "String", # required
894
+ # master_username: "String",
895
+ # master_user_password: "String",
896
896
  # preferred_backup_window: "String",
897
897
  # preferred_maintenance_window: "String",
898
898
  # tags: [
@@ -906,6 +906,7 @@ module Aws::DocDB
906
906
  # pre_signed_url: "String",
907
907
  # enable_cloudwatch_logs_exports: ["String"],
908
908
  # deletion_protection: false,
909
+ # global_cluster_identifier: "GlobalClusterIdentifier",
909
910
  # source_region: "String",
910
911
  # })
911
912
  #
@@ -930,6 +931,9 @@ module Aws::DocDB
930
931
  # resp.db_cluster.master_username #=> String
931
932
  # resp.db_cluster.preferred_backup_window #=> String
932
933
  # resp.db_cluster.preferred_maintenance_window #=> String
934
+ # resp.db_cluster.replication_source_identifier #=> String
935
+ # resp.db_cluster.read_replica_identifiers #=> Array
936
+ # resp.db_cluster.read_replica_identifiers[0] #=> String
933
937
  # resp.db_cluster.db_cluster_members #=> Array
934
938
  # resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
935
939
  # resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -1147,7 +1151,7 @@ module Aws::DocDB
1147
1151
  # The Amazon EC2 Availability Zone that the instance is created in.
1148
1152
  #
1149
1153
  # Default: A random, system-chosen Availability Zone in the endpoint's
1150
- # AWS Region.
1154
+ # Region.
1151
1155
  #
1152
1156
  # Example: `us-east-1d`
1153
1157
  #
@@ -1158,18 +1162,17 @@ module Aws::DocDB
1158
1162
  # Format: `ddd:hh24:mi-ddd:hh24:mi`
1159
1163
  #
1160
1164
  # The default is a 30-minute window selected at random from an 8-hour
1161
- # block of time for each AWS Region, occurring on a random day of the
1162
- # week.
1165
+ # block of time for each Region, occurring on a random day of the week.
1163
1166
  #
1164
1167
  # Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
1165
1168
  #
1166
1169
  # Constraints: Minimum 30-minute window.
1167
1170
  #
1168
1171
  # @option params [Boolean] :auto_minor_version_upgrade
1169
- # Indicates that minor engine upgrades are applied automatically to the
1170
- # instance during the maintenance window.
1172
+ # This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
1173
+ # does not perform minor version upgrades regardless of the value set.
1171
1174
  #
1172
- # Default: `true`
1175
+ # Default: `false`
1173
1176
  #
1174
1177
  # @option params [Array<Types::Tag>] :tags
1175
1178
  # The tags to be assigned to the instance. You can assign up to 10 tags
@@ -1282,7 +1285,7 @@ module Aws::DocDB
1282
1285
  end
1283
1286
 
1284
1287
  # Creates a new subnet group. subnet groups must contain at least one
1285
- # subnet in at least two Availability Zones in the AWS Region.
1288
+ # subnet in at least two Availability Zones in the Region.
1286
1289
  #
1287
1290
  # @option params [required, String] :db_subnet_group_name
1288
1291
  # The name for the subnet group. This value is stored as a lowercase
@@ -1383,7 +1386,7 @@ module Aws::DocDB
1383
1386
  # events are returned.
1384
1387
  #
1385
1388
  # Valid values: `db-instance`, `db-cluster`, `db-parameter-group`,
1386
- # `db-security-group`, `db-snapshot`, `db-cluster-snapshot`
1389
+ # `db-security-group`, `db-cluster-snapshot`
1387
1390
  #
1388
1391
  # @option params [Array<String>] :event_categories
1389
1392
  # A list of event categories for a `SourceType` that you want to
@@ -1464,6 +1467,91 @@ module Aws::DocDB
1464
1467
  req.send_request(options)
1465
1468
  end
1466
1469
 
1470
+ # Creates an Amazon DocumentDB global cluster that can span multiple
1471
+ # multiple Regions. The global cluster contains one primary cluster with
1472
+ # read-write capability, and up-to give read-only secondary clusters.
1473
+ # Global clusters uses storage-based fast replication across regions
1474
+ # with latencies less than one second, using dedicated infrastructure
1475
+ # with no impact to your workload’s performance.
1476
+ #
1477
+ #
1478
+ #
1479
+ # You can create a global cluster that is initially empty, and then add
1480
+ # a primary and a secondary to it. Or you can specify an existing
1481
+ # cluster during the create operation, and this cluster becomes the
1482
+ # primary of the global cluster.
1483
+ #
1484
+ # <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
1485
+ #
1486
+ # </note>
1487
+ #
1488
+ # @option params [required, String] :global_cluster_identifier
1489
+ # The cluster identifier of the new global cluster.
1490
+ #
1491
+ # @option params [String] :source_db_cluster_identifier
1492
+ # The Amazon Resource Name (ARN) to use as the primary cluster of the
1493
+ # global cluster. This parameter is optional.
1494
+ #
1495
+ # @option params [String] :engine
1496
+ # The name of the database engine to be used for this cluster.
1497
+ #
1498
+ # @option params [String] :engine_version
1499
+ # The engine version of the global cluster.
1500
+ #
1501
+ # @option params [Boolean] :deletion_protection
1502
+ # The deletion protection setting for the new global cluster. The global
1503
+ # cluster can't be deleted when deletion protection is enabled.
1504
+ #
1505
+ # @option params [String] :database_name
1506
+ # The name for your database of up to 64 alpha-numeric characters. If
1507
+ # you do not provide a name, Amazon DocumentDB will not create a
1508
+ # database in the global cluster you are creating.
1509
+ #
1510
+ # @option params [Boolean] :storage_encrypted
1511
+ # The storage encryption setting for the new global cluster.
1512
+ #
1513
+ # @return [Types::CreateGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1514
+ #
1515
+ # * {Types::CreateGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
1516
+ #
1517
+ # @example Request syntax with placeholder values
1518
+ #
1519
+ # resp = client.create_global_cluster({
1520
+ # global_cluster_identifier: "GlobalClusterIdentifier", # required
1521
+ # source_db_cluster_identifier: "String",
1522
+ # engine: "String",
1523
+ # engine_version: "String",
1524
+ # deletion_protection: false,
1525
+ # database_name: "String",
1526
+ # storage_encrypted: false,
1527
+ # })
1528
+ #
1529
+ # @example Response structure
1530
+ #
1531
+ # resp.global_cluster.global_cluster_identifier #=> String
1532
+ # resp.global_cluster.global_cluster_resource_id #=> String
1533
+ # resp.global_cluster.global_cluster_arn #=> String
1534
+ # resp.global_cluster.status #=> String
1535
+ # resp.global_cluster.engine #=> String
1536
+ # resp.global_cluster.engine_version #=> String
1537
+ # resp.global_cluster.database_name #=> String
1538
+ # resp.global_cluster.storage_encrypted #=> Boolean
1539
+ # resp.global_cluster.deletion_protection #=> Boolean
1540
+ # resp.global_cluster.global_cluster_members #=> Array
1541
+ # resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
1542
+ # resp.global_cluster.global_cluster_members[0].readers #=> Array
1543
+ # resp.global_cluster.global_cluster_members[0].readers[0] #=> String
1544
+ # resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
1545
+ #
1546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateGlobalCluster AWS API Documentation
1547
+ #
1548
+ # @overload create_global_cluster(params = {})
1549
+ # @param [Hash] params ({})
1550
+ def create_global_cluster(params = {}, options = {})
1551
+ req = build_request(:create_global_cluster, params)
1552
+ req.send_request(options)
1553
+ end
1554
+
1467
1555
  # Deletes a previously provisioned cluster. When you delete a cluster,
1468
1556
  # all automated backups for that cluster are deleted and can't be
1469
1557
  # recovered. Manual DB cluster snapshots of the specified cluster are
@@ -1542,6 +1630,9 @@ module Aws::DocDB
1542
1630
  # resp.db_cluster.master_username #=> String
1543
1631
  # resp.db_cluster.preferred_backup_window #=> String
1544
1632
  # resp.db_cluster.preferred_maintenance_window #=> String
1633
+ # resp.db_cluster.replication_source_identifier #=> String
1634
+ # resp.db_cluster.read_replica_identifiers #=> Array
1635
+ # resp.db_cluster.read_replica_identifiers[0] #=> String
1545
1636
  # resp.db_cluster.db_cluster_members #=> Array
1546
1637
  # resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
1547
1638
  # resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -1827,8 +1918,55 @@ module Aws::DocDB
1827
1918
  req.send_request(options)
1828
1919
  end
1829
1920
 
1921
+ # Deletes a global cluster. The primary and secondary clusters must
1922
+ # already be detached or deleted before attempting to delete a global
1923
+ # cluster.
1924
+ #
1925
+ # <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
1926
+ #
1927
+ # </note>
1928
+ #
1929
+ # @option params [required, String] :global_cluster_identifier
1930
+ # The cluster identifier of the global cluster being deleted.
1931
+ #
1932
+ # @return [Types::DeleteGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1933
+ #
1934
+ # * {Types::DeleteGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
1935
+ #
1936
+ # @example Request syntax with placeholder values
1937
+ #
1938
+ # resp = client.delete_global_cluster({
1939
+ # global_cluster_identifier: "GlobalClusterIdentifier", # required
1940
+ # })
1941
+ #
1942
+ # @example Response structure
1943
+ #
1944
+ # resp.global_cluster.global_cluster_identifier #=> String
1945
+ # resp.global_cluster.global_cluster_resource_id #=> String
1946
+ # resp.global_cluster.global_cluster_arn #=> String
1947
+ # resp.global_cluster.status #=> String
1948
+ # resp.global_cluster.engine #=> String
1949
+ # resp.global_cluster.engine_version #=> String
1950
+ # resp.global_cluster.database_name #=> String
1951
+ # resp.global_cluster.storage_encrypted #=> Boolean
1952
+ # resp.global_cluster.deletion_protection #=> Boolean
1953
+ # resp.global_cluster.global_cluster_members #=> Array
1954
+ # resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
1955
+ # resp.global_cluster.global_cluster_members[0].readers #=> Array
1956
+ # resp.global_cluster.global_cluster_members[0].readers[0] #=> String
1957
+ # resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
1958
+ #
1959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteGlobalCluster AWS API Documentation
1960
+ #
1961
+ # @overload delete_global_cluster(params = {})
1962
+ # @param [Hash] params ({})
1963
+ def delete_global_cluster(params = {}, options = {})
1964
+ req = build_request(:delete_global_cluster, params)
1965
+ req.send_request(options)
1966
+ end
1967
+
1830
1968
  # Returns a list of certificate authority (CA) certificates provided by
1831
- # Amazon DocumentDB for this AWS account.
1969
+ # Amazon DocumentDB for this account.
1832
1970
  #
1833
1971
  # @option params [String] :certificate_identifier
1834
1972
  # The user-supplied certificate identifier. If this parameter is
@@ -2063,12 +2201,12 @@ module Aws::DocDB
2063
2201
  # Returns a list of cluster snapshot attribute names and values for a
2064
2202
  # manual DB cluster snapshot.
2065
2203
  #
2066
- # When you share snapshots with other AWS accounts,
2204
+ # When you share snapshots with other accounts,
2067
2205
  # `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
2068
- # and a list of IDs for the AWS accounts that are authorized to copy or
2206
+ # and a list of IDs for the accounts that are authorized to copy or
2069
2207
  # restore the manual cluster snapshot. If `all` is included in the list
2070
2208
  # of values for the `restore` attribute, then the manual cluster
2071
- # snapshot is public and can be copied or restored by all AWS accounts.
2209
+ # snapshot is public and can be copied or restored by all accounts.
2072
2210
  #
2073
2211
  # @option params [required, String] :db_cluster_snapshot_identifier
2074
2212
  # The identifier for the cluster snapshot to describe the attributes
@@ -2133,13 +2271,13 @@ module Aws::DocDB
2133
2271
  # the following values:
2134
2272
  #
2135
2273
  # * `automated` - Return all cluster snapshots that Amazon DocumentDB
2136
- # has automatically created for your AWS account.
2274
+ # has automatically created for your account.
2137
2275
  #
2138
2276
  # * `manual` - Return all cluster snapshots that you have manually
2139
- # created for your AWS account.
2277
+ # created for your account.
2140
2278
  #
2141
2279
  # * `shared` - Return all manual cluster snapshots that have been shared
2142
- # to your AWS account.
2280
+ # to your account.
2143
2281
  #
2144
2282
  # * `public` - Return all cluster snapshots that have been marked as
2145
2283
  # public.
@@ -2148,7 +2286,7 @@ module Aws::DocDB
2148
2286
  # manual cluster snapshots are returned. You can include shared cluster
2149
2287
  # snapshots with these results by setting the `IncludeShared` parameter
2150
2288
  # to `true`. You can include public cluster snapshots with these results
2151
- # by setting the `IncludePublic` parameter to `true`.
2289
+ # by setting the`IncludePublic` parameter to `true`.
2152
2290
  #
2153
2291
  # The `IncludeShared` and `IncludePublic` parameters don't apply for
2154
2292
  # `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
@@ -2176,13 +2314,13 @@ module Aws::DocDB
2176
2314
  #
2177
2315
  # @option params [Boolean] :include_shared
2178
2316
  # Set to `true` to include shared manual cluster snapshots from other
2179
- # AWS accounts that this AWS account has been given permission to copy
2180
- # or restore, and otherwise `false`. The default is `false`.
2317
+ # accounts that this account has been given permission to copy or
2318
+ # restore, and otherwise `false`. The default is `false`.
2181
2319
  #
2182
2320
  # @option params [Boolean] :include_public
2183
2321
  # Set to `true` to include manual cluster snapshots that are public and
2184
- # can be copied or restored by any AWS account, and otherwise `false`.
2185
- # The default is `false`.
2322
+ # can be copied or restored by any account, and otherwise `false`. The
2323
+ # default is `false`.
2186
2324
  #
2187
2325
  # @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2188
2326
  #
@@ -2329,6 +2467,9 @@ module Aws::DocDB
2329
2467
  # resp.db_clusters[0].master_username #=> String
2330
2468
  # resp.db_clusters[0].preferred_backup_window #=> String
2331
2469
  # resp.db_clusters[0].preferred_maintenance_window #=> String
2470
+ # resp.db_clusters[0].replication_source_identifier #=> String
2471
+ # resp.db_clusters[0].read_replica_identifiers #=> Array
2472
+ # resp.db_clusters[0].read_replica_identifiers[0] #=> String
2332
2473
  # resp.db_clusters[0].db_cluster_members #=> Array
2333
2474
  # resp.db_clusters[0].db_cluster_members[0].db_instance_identifier #=> String
2334
2475
  # resp.db_clusters[0].db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -2750,8 +2891,7 @@ module Aws::DocDB
2750
2891
  # @option params [String] :source_type
2751
2892
  # The type of source that is generating the events.
2752
2893
  #
2753
- # Valid values: `db-instance`, `db-parameter-group`,
2754
- # `db-security-group`, `db-snapshot`
2894
+ # Valid values: `db-instance`, `db-parameter-group`, `db-security-group`
2755
2895
  #
2756
2896
  # @option params [Array<Types::Filter>] :filters
2757
2897
  # This parameter is not currently supported.
@@ -2984,6 +3124,86 @@ module Aws::DocDB
2984
3124
  req.send_request(options)
2985
3125
  end
2986
3126
 
3127
+ # Returns information about Amazon DocumentDB global clusters. This API
3128
+ # supports pagination.
3129
+ #
3130
+ # <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
3131
+ #
3132
+ # </note>
3133
+ #
3134
+ # @option params [String] :global_cluster_identifier
3135
+ # The user-supplied cluster identifier. If this parameter is specified,
3136
+ # information from only the specific cluster is returned. This parameter
3137
+ # isn't case-sensitive.
3138
+ #
3139
+ # @option params [Array<Types::Filter>] :filters
3140
+ # A filter that specifies one or more global DB clusters to describe.
3141
+ #
3142
+ # Supported filters: `db-cluster-id` accepts cluster identifiers and
3143
+ # cluster Amazon Resource Names (ARNs). The results list will only
3144
+ # include information about the clusters identified by these ARNs.
3145
+ #
3146
+ # @option params [Integer] :max_records
3147
+ # The maximum number of records to include in the response. If more
3148
+ # records exist than the specified `MaxRecords` value, a pagination
3149
+ # token called a marker is included in the response so that you can
3150
+ # retrieve the remaining results.
3151
+ #
3152
+ # @option params [String] :marker
3153
+ # An optional pagination token provided by a previous
3154
+ # `DescribeGlobalClusters` request. If this parameter is specified, the
3155
+ # response includes only records beyond the marker, up to the value
3156
+ # specified by `MaxRecords`.
3157
+ #
3158
+ # @return [Types::GlobalClustersMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3159
+ #
3160
+ # * {Types::GlobalClustersMessage#marker #marker} => String
3161
+ # * {Types::GlobalClustersMessage#global_clusters #global_clusters} => Array&lt;Types::GlobalCluster&gt;
3162
+ #
3163
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3164
+ #
3165
+ # @example Request syntax with placeholder values
3166
+ #
3167
+ # resp = client.describe_global_clusters({
3168
+ # global_cluster_identifier: "GlobalClusterIdentifier",
3169
+ # filters: [
3170
+ # {
3171
+ # name: "String", # required
3172
+ # values: ["String"], # required
3173
+ # },
3174
+ # ],
3175
+ # max_records: 1,
3176
+ # marker: "String",
3177
+ # })
3178
+ #
3179
+ # @example Response structure
3180
+ #
3181
+ # resp.marker #=> String
3182
+ # resp.global_clusters #=> Array
3183
+ # resp.global_clusters[0].global_cluster_identifier #=> String
3184
+ # resp.global_clusters[0].global_cluster_resource_id #=> String
3185
+ # resp.global_clusters[0].global_cluster_arn #=> String
3186
+ # resp.global_clusters[0].status #=> String
3187
+ # resp.global_clusters[0].engine #=> String
3188
+ # resp.global_clusters[0].engine_version #=> String
3189
+ # resp.global_clusters[0].database_name #=> String
3190
+ # resp.global_clusters[0].storage_encrypted #=> Boolean
3191
+ # resp.global_clusters[0].deletion_protection #=> Boolean
3192
+ # resp.global_clusters[0].global_cluster_members #=> Array
3193
+ # resp.global_clusters[0].global_cluster_members[0].db_cluster_arn #=> String
3194
+ # resp.global_clusters[0].global_cluster_members[0].readers #=> Array
3195
+ # resp.global_clusters[0].global_cluster_members[0].readers[0] #=> String
3196
+ # resp.global_clusters[0].global_cluster_members[0].is_writer #=> Boolean
3197
+ #
3198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeGlobalClusters AWS API Documentation
3199
+ #
3200
+ # @overload describe_global_clusters(params = {})
3201
+ # @param [Hash] params ({})
3202
+ def describe_global_clusters(params = {}, options = {})
3203
+ req = build_request(:describe_global_clusters, params)
3204
+ req.send_request(options)
3205
+ end
3206
+
2987
3207
  # Returns a list of orderable instance options for the specified engine.
2988
3208
  #
2989
3209
  # @option params [required, String] :engine
@@ -3206,6 +3426,9 @@ module Aws::DocDB
3206
3426
  # resp.db_cluster.master_username #=> String
3207
3427
  # resp.db_cluster.preferred_backup_window #=> String
3208
3428
  # resp.db_cluster.preferred_maintenance_window #=> String
3429
+ # resp.db_cluster.replication_source_identifier #=> String
3430
+ # resp.db_cluster.read_replica_identifiers #=> Array
3431
+ # resp.db_cluster.read_replica_identifiers[0] #=> String
3209
3432
  # resp.db_cluster.db_cluster_members #=> Array
3210
3433
  # resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
3211
3434
  # resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -3360,7 +3583,7 @@ module Aws::DocDB
3360
3583
  # parameter.
3361
3584
  #
3362
3585
  # The default is a 30-minute window selected at random from an 8-hour
3363
- # block of time for each AWS Region.
3586
+ # block of time for each Region.
3364
3587
  #
3365
3588
  # Constraints:
3366
3589
  #
@@ -3379,8 +3602,7 @@ module Aws::DocDB
3379
3602
  # Format: `ddd:hh24:mi-ddd:hh24:mi`
3380
3603
  #
3381
3604
  # The default is a 30-minute window selected at random from an 8-hour
3382
- # block of time for each AWS Region, occurring on a random day of the
3383
- # week.
3605
+ # block of time for each Region, occurring on a random day of the week.
3384
3606
  #
3385
3607
  # Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
3386
3608
  #
@@ -3394,9 +3616,8 @@ module Aws::DocDB
3394
3616
  #
3395
3617
  # @option params [String] :engine_version
3396
3618
  # The version number of the database engine to which you want to
3397
- # upgrade. Changing this parameter results in an outage. The change is
3398
- # applied during the next maintenance window unless the
3399
- # `ApplyImmediately` parameter is set to `true`.
3619
+ # upgrade. Modifying engine version is not supported on Amazon
3620
+ # DocumentDB.
3400
3621
  #
3401
3622
  # @option params [Boolean] :deletion_protection
3402
3623
  # Specifies whether this cluster can be deleted. If `DeletionProtection`
@@ -3450,6 +3671,9 @@ module Aws::DocDB
3450
3671
  # resp.db_cluster.master_username #=> String
3451
3672
  # resp.db_cluster.preferred_backup_window #=> String
3452
3673
  # resp.db_cluster.preferred_maintenance_window #=> String
3674
+ # resp.db_cluster.replication_source_identifier #=> String
3675
+ # resp.db_cluster.read_replica_identifiers #=> Array
3676
+ # resp.db_cluster.read_replica_identifiers[0] #=> String
3453
3677
  # resp.db_cluster.db_cluster_members #=> Array
3454
3678
  # resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
3455
3679
  # resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -3544,19 +3768,19 @@ module Aws::DocDB
3544
3768
  end
3545
3769
 
3546
3770
  # Adds an attribute and values to, or removes an attribute and values
3547
- # from, a manual DB cluster snapshot.
3771
+ # from, a manual cluster snapshot.
3548
3772
  #
3549
- # To share a manual cluster snapshot with other AWS accounts, specify
3773
+ # To share a manual cluster snapshot with other accounts, specify
3550
3774
  # `restore` as the `AttributeName`, and use the `ValuesToAdd` parameter
3551
- # to add a list of IDs of the AWS accounts that are authorized to
3552
- # restore the manual cluster snapshot. Use the value `all` to make the
3553
- # manual cluster snapshot public, which means that it can be copied or
3554
- # restored by all AWS accounts. Do not add the `all` value for any
3555
- # manual DB cluster snapshots that contain private information that you
3556
- # don't want available to all AWS accounts. If a manual cluster
3557
- # snapshot is encrypted, it can be shared, but only by specifying a list
3558
- # of authorized AWS account IDs for the `ValuesToAdd` parameter. You
3559
- # can't use `all` as a value for that parameter in this case.
3775
+ # to add a list of IDs of the accounts that are authorized to restore
3776
+ # the manual cluster snapshot. Use the value `all` to make the manual
3777
+ # cluster snapshot public, which means that it can be copied or restored
3778
+ # by all accounts. Do not add the `all` value for any manual cluster
3779
+ # snapshots that contain private information that you don't want
3780
+ # available to all accounts. If a manual cluster snapshot is encrypted,
3781
+ # it can be shared, but only by specifying a list of authorized account
3782
+ # IDs for the `ValuesToAdd` parameter. You can't use `all` as a value
3783
+ # for that parameter in this case.
3560
3784
  #
3561
3785
  # @option params [required, String] :db_cluster_snapshot_identifier
3562
3786
  # The identifier for the cluster snapshot to modify the attributes for.
@@ -3564,31 +3788,30 @@ module Aws::DocDB
3564
3788
  # @option params [required, String] :attribute_name
3565
3789
  # The name of the cluster snapshot attribute to modify.
3566
3790
  #
3567
- # To manage authorization for other AWS accounts to copy or restore a
3568
- # manual cluster snapshot, set this value to `restore`.
3791
+ # To manage authorization for other accounts to copy or restore a manual
3792
+ # cluster snapshot, set this value to `restore`.
3569
3793
  #
3570
3794
  # @option params [Array<String>] :values_to_add
3571
3795
  # A list of cluster snapshot attributes to add to the attribute
3572
3796
  # specified by `AttributeName`.
3573
3797
  #
3574
- # To authorize other AWS accounts to copy or restore a manual cluster
3575
- # snapshot, set this list to include one or more AWS account IDs. To
3576
- # make the manual cluster snapshot restorable by any AWS account, set it
3577
- # to `all`. Do not add the `all` value for any manual cluster snapshots
3798
+ # To authorize other accounts to copy or restore a manual cluster
3799
+ # snapshot, set this list to include one or more account IDs. To make
3800
+ # the manual cluster snapshot restorable by any account, set it to
3801
+ # `all`. Do not add the `all` value for any manual cluster snapshots
3578
3802
  # that contain private information that you don't want to be available
3579
- # to all AWS accounts.
3803
+ # to all accounts.
3580
3804
  #
3581
3805
  # @option params [Array<String>] :values_to_remove
3582
3806
  # A list of cluster snapshot attributes to remove from the attribute
3583
3807
  # specified by `AttributeName`.
3584
3808
  #
3585
- # To remove authorization for other AWS accounts to copy or restore a
3586
- # manual cluster snapshot, set this list to include one or more AWS
3587
- # account identifiers. To remove authorization for any AWS account to
3588
- # copy or restore the cluster snapshot, set it to `all` . If you specify
3589
- # `all`, an AWS account whose account ID is explicitly added to the
3590
- # `restore` attribute can still copy or restore a manual cluster
3591
- # snapshot.
3809
+ # To remove authorization for other accounts to copy or restore a manual
3810
+ # cluster snapshot, set this list to include one or more account
3811
+ # identifiers. To remove authorization for any account to copy or
3812
+ # restore the cluster snapshot, set it to `all` . If you specify `all`,
3813
+ # an account whose account ID is explicitly added to the `restore`
3814
+ # attribute can still copy or restore a manual cluster snapshot.
3592
3815
  #
3593
3816
  # @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3594
3817
  #
@@ -3635,8 +3858,7 @@ module Aws::DocDB
3635
3858
  #
3636
3859
  # @option params [String] :db_instance_class
3637
3860
  # The new compute and memory capacity of the instance; for example,
3638
- # `db.r5.large`. Not all instance classes are available in all AWS
3639
- # Regions.
3861
+ # `db.r5.large`. Not all instance classes are available in all Regions.
3640
3862
  #
3641
3863
  # If you modify the instance class, an outage occurs during the change.
3642
3864
  # The change is applied during the next maintenance window, unless
@@ -3676,13 +3898,8 @@ module Aws::DocDB
3676
3898
  # Constraints: Must be at least 30 minutes.
3677
3899
  #
3678
3900
  # @option params [Boolean] :auto_minor_version_upgrade
3679
- # Indicates that minor version upgrades are applied automatically to the
3680
- # instance during the maintenance window. Changing this parameter
3681
- # doesn't result in an outage except in the following case, and the
3682
- # change is asynchronously applied as soon as possible. An outage
3683
- # results if this parameter is set to `true` during the maintenance
3684
- # window, and a newer minor version is available, and Amazon DocumentDB
3685
- # has enabled automatic patching for that engine version.
3901
+ # This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
3902
+ # does not perform minor version upgrades regardless of the value set.
3686
3903
  #
3687
3904
  # @option params [String] :new_db_instance_identifier
3688
3905
  # The new instance identifier for the instance when renaming an
@@ -3803,7 +4020,7 @@ module Aws::DocDB
3803
4020
  end
3804
4021
 
3805
4022
  # Modifies an existing subnet group. subnet groups must contain at least
3806
- # one subnet in at least two Availability Zones in the AWS Region.
4023
+ # one subnet in at least two Availability Zones in the Region.
3807
4024
  #
3808
4025
  # @option params [required, String] :db_subnet_group_name
3809
4026
  # The name for the subnet group. This value is stored as a lowercase
@@ -3870,8 +4087,7 @@ module Aws::DocDB
3870
4087
  # parameter to `db-instance`. If this value is not specified, all events
3871
4088
  # are returned.
3872
4089
  #
3873
- # Valid values: `db-instance`, `db-parameter-group`,
3874
- # `db-security-group`, `db-snapshot`
4090
+ # Valid values: `db-instance`, `db-parameter-group`, `db-security-group`
3875
4091
  #
3876
4092
  # @option params [Array<String>] :event_categories
3877
4093
  # A list of event categories for a `SourceType` that you want to
@@ -3918,6 +4134,79 @@ module Aws::DocDB
3918
4134
  req.send_request(options)
3919
4135
  end
3920
4136
 
4137
+ # Modify a setting for an Amazon DocumentDB global cluster. You can
4138
+ # change one or more configuration parameters (for example: deletion
4139
+ # protection), or the global cluster identifier by specifying these
4140
+ # parameters and the new values in the request.
4141
+ #
4142
+ # <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
4143
+ #
4144
+ # </note>
4145
+ #
4146
+ # @option params [required, String] :global_cluster_identifier
4147
+ # The identifier for the global cluster being modified. This parameter
4148
+ # isn't case-sensitive.
4149
+ #
4150
+ # Constraints:
4151
+ #
4152
+ # * Must match the identifier of an existing global cluster.
4153
+ #
4154
+ # ^
4155
+ #
4156
+ # @option params [String] :new_global_cluster_identifier
4157
+ # The new identifier for a global cluster when you modify a global
4158
+ # cluster. This value is stored as a lowercase string.
4159
+ #
4160
+ # * Must contain from 1 to 63 letters, numbers, or hyphens
4161
+ #
4162
+ # The first character must be a letter
4163
+ #
4164
+ # Can't end with a hyphen or contain two consecutive hyphens
4165
+ #
4166
+ # Example: `my-cluster2`
4167
+ #
4168
+ # @option params [Boolean] :deletion_protection
4169
+ # Indicates if the global cluster has deletion protection enabled. The
4170
+ # global cluster can't be deleted when deletion protection is enabled.
4171
+ #
4172
+ # @return [Types::ModifyGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4173
+ #
4174
+ # * {Types::ModifyGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
4175
+ #
4176
+ # @example Request syntax with placeholder values
4177
+ #
4178
+ # resp = client.modify_global_cluster({
4179
+ # global_cluster_identifier: "GlobalClusterIdentifier", # required
4180
+ # new_global_cluster_identifier: "GlobalClusterIdentifier",
4181
+ # deletion_protection: false,
4182
+ # })
4183
+ #
4184
+ # @example Response structure
4185
+ #
4186
+ # resp.global_cluster.global_cluster_identifier #=> String
4187
+ # resp.global_cluster.global_cluster_resource_id #=> String
4188
+ # resp.global_cluster.global_cluster_arn #=> String
4189
+ # resp.global_cluster.status #=> String
4190
+ # resp.global_cluster.engine #=> String
4191
+ # resp.global_cluster.engine_version #=> String
4192
+ # resp.global_cluster.database_name #=> String
4193
+ # resp.global_cluster.storage_encrypted #=> Boolean
4194
+ # resp.global_cluster.deletion_protection #=> Boolean
4195
+ # resp.global_cluster.global_cluster_members #=> Array
4196
+ # resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
4197
+ # resp.global_cluster.global_cluster_members[0].readers #=> Array
4198
+ # resp.global_cluster.global_cluster_members[0].readers[0] #=> String
4199
+ # resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
4200
+ #
4201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyGlobalCluster AWS API Documentation
4202
+ #
4203
+ # @overload modify_global_cluster(params = {})
4204
+ # @param [Hash] params ({})
4205
+ def modify_global_cluster(params = {}, options = {})
4206
+ req = build_request(:modify_global_cluster, params)
4207
+ req.send_request(options)
4208
+ end
4209
+
3921
4210
  # You might need to reboot your instance, usually for maintenance
3922
4211
  # reasons. For example, if you make certain changes, or if you change
3923
4212
  # the cluster parameter group that is associated with the instance, you
@@ -4025,6 +4314,60 @@ module Aws::DocDB
4025
4314
  req.send_request(options)
4026
4315
  end
4027
4316
 
4317
+ # Detaches an Amazon DocumentDB secondary cluster from a global cluster.
4318
+ # The cluster becomes a standalone cluster with read-write capability
4319
+ # instead of being read-only and receiving data from a primary in a
4320
+ # different region.
4321
+ #
4322
+ # <note markdown="1"> This action only applies to Amazon DocumentDB clusters.
4323
+ #
4324
+ # </note>
4325
+ #
4326
+ # @option params [required, String] :global_cluster_identifier
4327
+ # The cluster identifier to detach from the Amazon DocumentDB global
4328
+ # cluster.
4329
+ #
4330
+ # @option params [required, String] :db_cluster_identifier
4331
+ # The Amazon Resource Name (ARN) identifying the cluster that was
4332
+ # detached from the Amazon DocumentDB global cluster.
4333
+ #
4334
+ # @return [Types::RemoveFromGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4335
+ #
4336
+ # * {Types::RemoveFromGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
4337
+ #
4338
+ # @example Request syntax with placeholder values
4339
+ #
4340
+ # resp = client.remove_from_global_cluster({
4341
+ # global_cluster_identifier: "GlobalClusterIdentifier", # required
4342
+ # db_cluster_identifier: "String", # required
4343
+ # })
4344
+ #
4345
+ # @example Response structure
4346
+ #
4347
+ # resp.global_cluster.global_cluster_identifier #=> String
4348
+ # resp.global_cluster.global_cluster_resource_id #=> String
4349
+ # resp.global_cluster.global_cluster_arn #=> String
4350
+ # resp.global_cluster.status #=> String
4351
+ # resp.global_cluster.engine #=> String
4352
+ # resp.global_cluster.engine_version #=> String
4353
+ # resp.global_cluster.database_name #=> String
4354
+ # resp.global_cluster.storage_encrypted #=> Boolean
4355
+ # resp.global_cluster.deletion_protection #=> Boolean
4356
+ # resp.global_cluster.global_cluster_members #=> Array
4357
+ # resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
4358
+ # resp.global_cluster.global_cluster_members[0].readers #=> Array
4359
+ # resp.global_cluster.global_cluster_members[0].readers[0] #=> String
4360
+ # resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
4361
+ #
4362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveFromGlobalCluster AWS API Documentation
4363
+ #
4364
+ # @overload remove_from_global_cluster(params = {})
4365
+ # @param [Hash] params ({})
4366
+ def remove_from_global_cluster(params = {}, options = {})
4367
+ req = build_request(:remove_from_global_cluster, params)
4368
+ req.send_request(options)
4369
+ end
4370
+
4028
4371
  # Removes a source identifier from an existing Amazon DocumentDB event
4029
4372
  # notification subscription.
4030
4373
  #
@@ -4235,21 +4578,21 @@ module Aws::DocDB
4235
4578
  # The tags to be assigned to the restored cluster.
4236
4579
  #
4237
4580
  # @option params [String] :kms_key_id
4238
- # The AWS KMS key identifier to use when restoring an encrypted cluster
4239
- # from a DB snapshot or cluster snapshot.
4581
+ # The KMS key identifier to use when restoring an encrypted cluster from
4582
+ # a DB snapshot or cluster snapshot.
4240
4583
  #
4241
- # The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
4242
- # AWS KMS encryption key. If you are restoring a cluster with the same
4243
- # AWS account that owns the AWS KMS encryption key used to encrypt the
4244
- # new cluster, then you can use the AWS KMS key alias instead of the ARN
4245
- # for the AWS KMS encryption key.
4584
+ # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
4585
+ # encryption key. If you are restoring a cluster with the same account
4586
+ # that owns the KMS encryption key used to encrypt the new cluster, then
4587
+ # you can use the KMS key alias instead of the ARN for the KMS
4588
+ # encryption key.
4246
4589
  #
4247
4590
  # If you do not specify a value for the `KmsKeyId` parameter, then the
4248
4591
  # following occurs:
4249
4592
  #
4250
4593
  # * If the snapshot or cluster snapshot in `SnapshotIdentifier` is
4251
- # encrypted, then the restored cluster is encrypted using the AWS KMS
4252
- # key that was used to encrypt the snapshot or the cluster snapshot.
4594
+ # encrypted, then the restored cluster is encrypted using the KMS key
4595
+ # that was used to encrypt the snapshot or the cluster snapshot.
4253
4596
  #
4254
4597
  # * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is
4255
4598
  # not encrypted, then the restored DB cluster is not encrypted.
@@ -4311,6 +4654,9 @@ module Aws::DocDB
4311
4654
  # resp.db_cluster.master_username #=> String
4312
4655
  # resp.db_cluster.preferred_backup_window #=> String
4313
4656
  # resp.db_cluster.preferred_maintenance_window #=> String
4657
+ # resp.db_cluster.replication_source_identifier #=> String
4658
+ # resp.db_cluster.read_replica_identifiers #=> Array
4659
+ # resp.db_cluster.read_replica_identifiers[0] #=> String
4314
4660
  # resp.db_cluster.db_cluster_members #=> Array
4315
4661
  # resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
4316
4662
  # resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -4419,25 +4765,25 @@ module Aws::DocDB
4419
4765
  # The tags to be assigned to the restored cluster.
4420
4766
  #
4421
4767
  # @option params [String] :kms_key_id
4422
- # The AWS KMS key identifier to use when restoring an encrypted cluster
4423
- # from an encrypted cluster.
4768
+ # The KMS key identifier to use when restoring an encrypted cluster from
4769
+ # an encrypted cluster.
4424
4770
  #
4425
- # The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
4426
- # AWS KMS encryption key. If you are restoring a cluster with the same
4427
- # AWS account that owns the AWS KMS encryption key used to encrypt the
4428
- # new cluster, then you can use the AWS KMS key alias instead of the ARN
4429
- # for the AWS KMS encryption key.
4771
+ # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
4772
+ # encryption key. If you are restoring a cluster with the same account
4773
+ # that owns the KMS encryption key used to encrypt the new cluster, then
4774
+ # you can use the KMS key alias instead of the ARN for the KMS
4775
+ # encryption key.
4430
4776
  #
4431
4777
  # You can restore to a new cluster and encrypt the new cluster with an
4432
- # AWS KMS key that is different from the AWS KMS key used to encrypt the
4433
- # source cluster. The new DB cluster is encrypted with the AWS KMS key
4434
- # identified by the `KmsKeyId` parameter.
4778
+ # KMS key that is different from the KMS key used to encrypt the source
4779
+ # cluster. The new DB cluster is encrypted with the KMS key identified
4780
+ # by the `KmsKeyId` parameter.
4435
4781
  #
4436
4782
  # If you do not specify a value for the `KmsKeyId` parameter, then the
4437
4783
  # following occurs:
4438
4784
  #
4439
4785
  # * If the cluster is encrypted, then the restored cluster is encrypted
4440
- # using the AWS KMS key that was used to encrypt the source cluster.
4786
+ # using the KMS key that was used to encrypt the source cluster.
4441
4787
  #
4442
4788
  # * If the cluster is not encrypted, then the restored cluster is not
4443
4789
  # encrypted.
@@ -4501,6 +4847,9 @@ module Aws::DocDB
4501
4847
  # resp.db_cluster.master_username #=> String
4502
4848
  # resp.db_cluster.preferred_backup_window #=> String
4503
4849
  # resp.db_cluster.preferred_maintenance_window #=> String
4850
+ # resp.db_cluster.replication_source_identifier #=> String
4851
+ # resp.db_cluster.read_replica_identifiers #=> Array
4852
+ # resp.db_cluster.read_replica_identifiers[0] #=> String
4504
4853
  # resp.db_cluster.db_cluster_members #=> Array
4505
4854
  # resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
4506
4855
  # resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -4574,6 +4923,9 @@ module Aws::DocDB
4574
4923
  # resp.db_cluster.master_username #=> String
4575
4924
  # resp.db_cluster.preferred_backup_window #=> String
4576
4925
  # resp.db_cluster.preferred_maintenance_window #=> String
4926
+ # resp.db_cluster.replication_source_identifier #=> String
4927
+ # resp.db_cluster.read_replica_identifiers #=> Array
4928
+ # resp.db_cluster.read_replica_identifiers[0] #=> String
4577
4929
  # resp.db_cluster.db_cluster_members #=> Array
4578
4930
  # resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
4579
4931
  # resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -4647,6 +4999,9 @@ module Aws::DocDB
4647
4999
  # resp.db_cluster.master_username #=> String
4648
5000
  # resp.db_cluster.preferred_backup_window #=> String
4649
5001
  # resp.db_cluster.preferred_maintenance_window #=> String
5002
+ # resp.db_cluster.replication_source_identifier #=> String
5003
+ # resp.db_cluster.read_replica_identifiers #=> Array
5004
+ # resp.db_cluster.read_replica_identifiers[0] #=> String
4650
5005
  # resp.db_cluster.db_cluster_members #=> Array
4651
5006
  # resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
4652
5007
  # resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
@@ -4690,7 +5045,7 @@ module Aws::DocDB
4690
5045
  params: params,
4691
5046
  config: config)
4692
5047
  context[:gem_name] = 'aws-sdk-docdb'
4693
- context[:gem_version] = '1.30.0'
5048
+ context[:gem_version] = '1.34.0'
4694
5049
  Seahorse::Client::Request.new(handlers, context)
4695
5050
  end
4696
5051