aws-sdk-docdb 1.40.0 → 1.43.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-docdb/client.rb +209 -97
- data/lib/aws-sdk-docdb/client_api.rb +9 -0
- data/lib/aws-sdk-docdb/types.rb +213 -100
- data/lib/aws-sdk-docdb.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-docdb/client.rb
CHANGED
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
@@ -76,6 +77,7 @@ module Aws::DocDB
|
|
76
77
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
77
78
|
add_plugin(Aws::Plugins::TransferEncoding)
|
78
79
|
add_plugin(Aws::Plugins::HttpChecksum)
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
79
81
|
add_plugin(Aws::Plugins::DefaultsMode)
|
80
82
|
add_plugin(Aws::Plugins::RecursionDetection)
|
81
83
|
add_plugin(Aws::Plugins::SignatureV4)
|
@@ -511,12 +513,14 @@ module Aws::DocDB
|
|
511
513
|
#
|
512
514
|
# * Must specify a valid cluster parameter group.
|
513
515
|
#
|
514
|
-
# * If the source cluster parameter group is in the same
|
515
|
-
# copy, specify a valid parameter group
|
516
|
-
# `my-db-cluster-param-group`, or a valid
|
516
|
+
# * If the source cluster parameter group is in the same Amazon Web
|
517
|
+
# Services Region as the copy, specify a valid parameter group
|
518
|
+
# identifier; for example, `my-db-cluster-param-group`, or a valid
|
519
|
+
# ARN.
|
517
520
|
#
|
518
|
-
# * If the source parameter group is in a different
|
519
|
-
# copy, specify a valid cluster parameter group ARN;
|
521
|
+
# * If the source parameter group is in a different Amazon Web Services
|
522
|
+
# Region than the copy, specify a valid cluster parameter group ARN;
|
523
|
+
# for example,
|
520
524
|
# `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
|
521
525
|
#
|
522
526
|
# @option params [required, String] :target_db_cluster_parameter_group_identifier
|
@@ -579,7 +583,8 @@ module Aws::DocDB
|
|
579
583
|
# To copy a cluster snapshot from a shared manual cluster snapshot,
|
580
584
|
# `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
|
581
585
|
# (ARN) of the shared cluster snapshot. You can only copy a shared DB
|
582
|
-
# cluster snapshot, whether encrypted or not, in the same
|
586
|
+
# cluster snapshot, whether encrypted or not, in the same Amazon Web
|
587
|
+
# Services Region.
|
583
588
|
#
|
584
589
|
# To cancel the copy operation after it is in progress, delete the
|
585
590
|
# target cluster snapshot identified by
|
@@ -594,11 +599,11 @@ module Aws::DocDB
|
|
594
599
|
#
|
595
600
|
# * Must specify a valid system snapshot in the *available* state.
|
596
601
|
#
|
597
|
-
# * If the source snapshot is in the same
|
598
|
-
# valid snapshot identifier.
|
602
|
+
# * If the source snapshot is in the same Amazon Web Services Region as
|
603
|
+
# the copy, specify a valid snapshot identifier.
|
599
604
|
#
|
600
|
-
# * If the source snapshot is in a different
|
601
|
-
# specify a valid cluster snapshot ARN.
|
605
|
+
# * If the source snapshot is in a different Amazon Web Services Region
|
606
|
+
# than the copy, specify a valid cluster snapshot ARN.
|
602
607
|
#
|
603
608
|
# Example: `my-cluster-snapshot1`
|
604
609
|
#
|
@@ -621,50 +626,56 @@ module Aws::DocDB
|
|
621
626
|
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
622
627
|
# alias for the KMS encryption key.
|
623
628
|
#
|
624
|
-
# If you copy an encrypted cluster snapshot from your
|
625
|
-
# specify a value for `KmsKeyId` to encrypt
|
626
|
-
# encryption key. If you don't specify a value
|
627
|
-
# copy of the cluster snapshot is encrypted
|
628
|
-
# source cluster snapshot.
|
629
|
+
# If you copy an encrypted cluster snapshot from your Amazon Web
|
630
|
+
# Services account, you can specify a value for `KmsKeyId` to encrypt
|
631
|
+
# the copy with a new KMS encryption key. If you don't specify a value
|
632
|
+
# for `KmsKeyId`, then the copy of the cluster snapshot is encrypted
|
633
|
+
# with the same KMS key as the source cluster snapshot.
|
629
634
|
#
|
630
635
|
# If you copy an encrypted cluster snapshot that is shared from another
|
631
|
-
# account, then you must specify a value for
|
636
|
+
# Amazon Web Services account, then you must specify a value for
|
637
|
+
# `KmsKeyId`.
|
632
638
|
#
|
633
|
-
# To copy an encrypted cluster snapshot to another
|
634
|
-
# `KmsKeyId` to the KMS key ID that you want to use to
|
635
|
-
# of the cluster snapshot in the destination Region.
|
636
|
-
# are specific to the
|
637
|
-
# use encryption keys from one
|
639
|
+
# To copy an encrypted cluster snapshot to another Amazon Web Services
|
640
|
+
# Region, set `KmsKeyId` to the KMS key ID that you want to use to
|
641
|
+
# encrypt the copy of the cluster snapshot in the destination Region.
|
642
|
+
# KMS encryption keys are specific to the Amazon Web Services Region
|
643
|
+
# that they are created in, and you can't use encryption keys from one
|
644
|
+
# Amazon Web Services Region in another Amazon Web Services Region.
|
638
645
|
#
|
639
646
|
# If you copy an unencrypted cluster snapshot and specify a value for
|
640
647
|
# the `KmsKeyId` parameter, an error is returned.
|
641
648
|
#
|
642
649
|
# @option params [String] :pre_signed_url
|
643
650
|
# The URL that contains a Signature Version 4 signed request for
|
644
|
-
# the`CopyDBClusterSnapshot` API action in the
|
645
|
-
# source cluster snapshot to copy. You must use
|
646
|
-
# parameter when copying a cluster snapshot from
|
651
|
+
# the`CopyDBClusterSnapshot` API action in the Amazon Web Services
|
652
|
+
# Region that contains the source cluster snapshot to copy. You must use
|
653
|
+
# the `PreSignedUrl` parameter when copying a cluster snapshot from
|
654
|
+
# another Amazon Web Services Region.
|
647
655
|
#
|
648
656
|
# If you are using an Amazon Web Services SDK tool or the CLI, you can
|
649
657
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
650
658
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
651
659
|
# autogenerates a pre-signed URL that is a valid request for the
|
652
|
-
# operation that can be executed in the source
|
660
|
+
# operation that can be executed in the source Amazon Web Services
|
661
|
+
# Region.
|
653
662
|
#
|
654
663
|
# The presigned URL must be a valid request for the
|
655
664
|
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
656
|
-
# Region that contains the cluster snapshot to be
|
657
|
-
# URL request must contain the following parameter
|
665
|
+
# Amazon Web Services Region that contains the cluster snapshot to be
|
666
|
+
# copied. The presigned URL request must contain the following parameter
|
667
|
+
# values:
|
658
668
|
#
|
659
669
|
# * `SourceRegion` - The ID of the region that contains the snapshot to
|
660
670
|
# be copied.
|
661
671
|
#
|
662
672
|
# * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
|
663
673
|
# encrypted cluster snapshot to be copied. This identifier must be in
|
664
|
-
# the Amazon Resource Name (ARN) format for the source
|
665
|
-
# example, if you are copying an encrypted
|
666
|
-
# us-east-1 Region, then
|
667
|
-
# looks something like the
|
674
|
+
# the Amazon Resource Name (ARN) format for the source Amazon Web
|
675
|
+
# Services Region. For example, if you are copying an encrypted
|
676
|
+
# cluster snapshot from the us-east-1 Amazon Web Services Region, then
|
677
|
+
# your `SourceDBClusterSnapshotIdentifier` looks something like the
|
678
|
+
# following:
|
668
679
|
# `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
|
669
680
|
#
|
670
681
|
# * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
|
@@ -820,7 +831,7 @@ module Aws::DocDB
|
|
820
831
|
# parameter.
|
821
832
|
#
|
822
833
|
# The default is a 30-minute window selected at random from an 8-hour
|
823
|
-
# block of time for each Region.
|
834
|
+
# block of time for each Amazon Web Services Region.
|
824
835
|
#
|
825
836
|
# Constraints:
|
826
837
|
#
|
@@ -839,7 +850,8 @@ module Aws::DocDB
|
|
839
850
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
840
851
|
#
|
841
852
|
# The default is a 30-minute window selected at random from an 8-hour
|
842
|
-
# block of time for each Region, occurring on a
|
853
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
854
|
+
# random day of the week.
|
843
855
|
#
|
844
856
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
845
857
|
#
|
@@ -855,10 +867,10 @@ module Aws::DocDB
|
|
855
867
|
# The KMS key identifier for an encrypted cluster.
|
856
868
|
#
|
857
869
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
858
|
-
# encryption key. If you are creating a cluster using the same
|
859
|
-
# that owns the KMS encryption key that is used to
|
860
|
-
# cluster, you can use the KMS key alias instead of the
|
861
|
-
# encryption key.
|
870
|
+
# encryption key. If you are creating a cluster using the same Amazon
|
871
|
+
# Web Services account that owns the KMS encryption key that is used to
|
872
|
+
# encrypt the new cluster, you can use the KMS key alias instead of the
|
873
|
+
# ARN for the KMS encryption key.
|
862
874
|
#
|
863
875
|
# If an encryption key is not specified in `KmsKeyId`\:
|
864
876
|
#
|
@@ -867,8 +879,9 @@ module Aws::DocDB
|
|
867
879
|
#
|
868
880
|
# ^
|
869
881
|
#
|
870
|
-
# KMS creates the default encryption key for your
|
871
|
-
#
|
882
|
+
# KMS creates the default encryption key for your Amazon Web Services
|
883
|
+
# account. Your Amazon Web Services account has a different default
|
884
|
+
# encryption key for each Amazon Web Services Regions.
|
872
885
|
#
|
873
886
|
# @option params [String] :pre_signed_url
|
874
887
|
# Not currently supported.
|
@@ -972,6 +985,7 @@ module Aws::DocDB
|
|
972
985
|
# resp.db_cluster.associated_roles #=> Array
|
973
986
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
974
987
|
# resp.db_cluster.associated_roles[0].status #=> String
|
988
|
+
# resp.db_cluster.clone_group_id #=> String
|
975
989
|
# resp.db_cluster.cluster_create_time #=> Time
|
976
990
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
977
991
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -1173,7 +1187,7 @@ module Aws::DocDB
|
|
1173
1187
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
1174
1188
|
#
|
1175
1189
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1176
|
-
# Region.
|
1190
|
+
# Amazon Web Services Region.
|
1177
1191
|
#
|
1178
1192
|
# Example: `us-east-1d`
|
1179
1193
|
#
|
@@ -1184,7 +1198,8 @@ module Aws::DocDB
|
|
1184
1198
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1185
1199
|
#
|
1186
1200
|
# The default is a 30-minute window selected at random from an 8-hour
|
1187
|
-
# block of time for each Region, occurring on a
|
1201
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
1202
|
+
# random day of the week.
|
1188
1203
|
#
|
1189
1204
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
1190
1205
|
#
|
@@ -1203,6 +1218,10 @@ module Aws::DocDB
|
|
1203
1218
|
# @option params [required, String] :db_cluster_identifier
|
1204
1219
|
# The identifier of the cluster that the instance will belong to.
|
1205
1220
|
#
|
1221
|
+
# @option params [Boolean] :copy_tags_to_snapshot
|
1222
|
+
# A value that indicates whether to copy tags from the DB instance to
|
1223
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
1224
|
+
#
|
1206
1225
|
# @option params [Integer] :promotion_tier
|
1207
1226
|
# A value that specifies the order in which an Amazon DocumentDB replica
|
1208
1227
|
# is promoted to the primary instance after a failure of the existing
|
@@ -1212,6 +1231,27 @@ module Aws::DocDB
|
|
1212
1231
|
#
|
1213
1232
|
# Valid values: 0-15
|
1214
1233
|
#
|
1234
|
+
# @option params [Boolean] :enable_performance_insights
|
1235
|
+
# A value that indicates whether to enable Performance Insights for the
|
1236
|
+
# DB Instance. For more information, see [Using Amazon Performance
|
1237
|
+
# Insights][1].
|
1238
|
+
#
|
1239
|
+
#
|
1240
|
+
#
|
1241
|
+
# [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html
|
1242
|
+
#
|
1243
|
+
# @option params [String] :performance_insights_kms_key_id
|
1244
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
1245
|
+
#
|
1246
|
+
# The KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1247
|
+
# name for the KMS key.
|
1248
|
+
#
|
1249
|
+
# If you do not specify a value for PerformanceInsightsKMSKeyId, then
|
1250
|
+
# Amazon DocumentDB uses your default KMS key. There is a default KMS
|
1251
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
1252
|
+
# account has a different default KMS key for each Amazon Web Services
|
1253
|
+
# region.
|
1254
|
+
#
|
1215
1255
|
# @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1216
1256
|
#
|
1217
1257
|
# * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -1232,7 +1272,10 @@ module Aws::DocDB
|
|
1232
1272
|
# },
|
1233
1273
|
# ],
|
1234
1274
|
# db_cluster_identifier: "String", # required
|
1275
|
+
# copy_tags_to_snapshot: false,
|
1235
1276
|
# promotion_tier: 1,
|
1277
|
+
# enable_performance_insights: false,
|
1278
|
+
# performance_insights_kms_key_id: "String",
|
1236
1279
|
# })
|
1237
1280
|
#
|
1238
1281
|
# @example Response structure
|
@@ -1292,6 +1335,7 @@ module Aws::DocDB
|
|
1292
1335
|
# resp.db_instance.kms_key_id #=> String
|
1293
1336
|
# resp.db_instance.dbi_resource_id #=> String
|
1294
1337
|
# resp.db_instance.ca_certificate_identifier #=> String
|
1338
|
+
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
1295
1339
|
# resp.db_instance.promotion_tier #=> Integer
|
1296
1340
|
# resp.db_instance.db_instance_arn #=> String
|
1297
1341
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
@@ -1307,7 +1351,8 @@ module Aws::DocDB
|
|
1307
1351
|
end
|
1308
1352
|
|
1309
1353
|
# Creates a new subnet group. subnet groups must contain at least one
|
1310
|
-
# subnet in at least two Availability Zones in the
|
1354
|
+
# subnet in at least two Availability Zones in the Amazon Web Services
|
1355
|
+
# Region.
|
1311
1356
|
#
|
1312
1357
|
# @option params [required, String] :db_subnet_group_name
|
1313
1358
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -1490,11 +1535,12 @@ module Aws::DocDB
|
|
1490
1535
|
end
|
1491
1536
|
|
1492
1537
|
# Creates an Amazon DocumentDB global cluster that can span multiple
|
1493
|
-
# multiple Regions. The global cluster contains one
|
1494
|
-
# read-write capability, and up-to give read-only
|
1495
|
-
# Global clusters uses storage-based fast
|
1496
|
-
# with latencies less than one second, using
|
1497
|
-
# with no impact to your workload’s
|
1538
|
+
# multiple Amazon Web Services Regions. The global cluster contains one
|
1539
|
+
# primary cluster with read-write capability, and up-to give read-only
|
1540
|
+
# secondary clusters. Global clusters uses storage-based fast
|
1541
|
+
# replication across regions with latencies less than one second, using
|
1542
|
+
# dedicated infrastructure with no impact to your workload’s
|
1543
|
+
# performance.
|
1498
1544
|
#
|
1499
1545
|
#
|
1500
1546
|
#
|
@@ -1671,6 +1717,7 @@ module Aws::DocDB
|
|
1671
1717
|
# resp.db_cluster.associated_roles #=> Array
|
1672
1718
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
1673
1719
|
# resp.db_cluster.associated_roles[0].status #=> String
|
1720
|
+
# resp.db_cluster.clone_group_id #=> String
|
1674
1721
|
# resp.db_cluster.cluster_create_time #=> Time
|
1675
1722
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
1676
1723
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -1848,6 +1895,7 @@ module Aws::DocDB
|
|
1848
1895
|
# resp.db_instance.kms_key_id #=> String
|
1849
1896
|
# resp.db_instance.dbi_resource_id #=> String
|
1850
1897
|
# resp.db_instance.ca_certificate_identifier #=> String
|
1898
|
+
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
1851
1899
|
# resp.db_instance.promotion_tier #=> Integer
|
1852
1900
|
# resp.db_instance.db_instance_arn #=> String
|
1853
1901
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
@@ -1988,7 +2036,7 @@ module Aws::DocDB
|
|
1988
2036
|
end
|
1989
2037
|
|
1990
2038
|
# Returns a list of certificate authority (CA) certificates provided by
|
1991
|
-
# Amazon DocumentDB for this account.
|
2039
|
+
# Amazon DocumentDB for this Amazon Web Services account.
|
1992
2040
|
#
|
1993
2041
|
# @option params [String] :certificate_identifier
|
1994
2042
|
# The user-supplied certificate identifier. If this parameter is
|
@@ -2223,12 +2271,13 @@ module Aws::DocDB
|
|
2223
2271
|
# Returns a list of cluster snapshot attribute names and values for a
|
2224
2272
|
# manual DB cluster snapshot.
|
2225
2273
|
#
|
2226
|
-
# When you share snapshots with other accounts,
|
2274
|
+
# When you share snapshots with other Amazon Web Services accounts,
|
2227
2275
|
# `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
|
2228
|
-
# and a list of IDs for the accounts that are
|
2229
|
-
# restore the manual cluster snapshot. If `all` is
|
2230
|
-
# of values for the `restore` attribute, then the
|
2231
|
-
# snapshot is public and can be copied or restored by all
|
2276
|
+
# and a list of IDs for the Amazon Web Services accounts that are
|
2277
|
+
# authorized to copy or restore the manual cluster snapshot. If `all` is
|
2278
|
+
# included in the list of values for the `restore` attribute, then the
|
2279
|
+
# manual cluster snapshot is public and can be copied or restored by all
|
2280
|
+
# Amazon Web Services accounts.
|
2232
2281
|
#
|
2233
2282
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
2234
2283
|
# The identifier for the cluster snapshot to describe the attributes
|
@@ -2293,13 +2342,13 @@ module Aws::DocDB
|
|
2293
2342
|
# the following values:
|
2294
2343
|
#
|
2295
2344
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2296
|
-
# has automatically created for your account.
|
2345
|
+
# has automatically created for your Amazon Web Services account.
|
2297
2346
|
#
|
2298
2347
|
# * `manual` - Return all cluster snapshots that you have manually
|
2299
|
-
# created for your account.
|
2348
|
+
# created for your Amazon Web Services account.
|
2300
2349
|
#
|
2301
2350
|
# * `shared` - Return all manual cluster snapshots that have been shared
|
2302
|
-
# to your account.
|
2351
|
+
# to your Amazon Web Services account.
|
2303
2352
|
#
|
2304
2353
|
# * `public` - Return all cluster snapshots that have been marked as
|
2305
2354
|
# public.
|
@@ -2336,13 +2385,14 @@ module Aws::DocDB
|
|
2336
2385
|
#
|
2337
2386
|
# @option params [Boolean] :include_shared
|
2338
2387
|
# Set to `true` to include shared manual cluster snapshots from other
|
2339
|
-
# accounts that this
|
2340
|
-
# restore, and otherwise `false`. The
|
2388
|
+
# Amazon Web Services accounts that this Amazon Web Services account has
|
2389
|
+
# been given permission to copy or restore, and otherwise `false`. The
|
2390
|
+
# default is `false`.
|
2341
2391
|
#
|
2342
2392
|
# @option params [Boolean] :include_public
|
2343
2393
|
# Set to `true` to include manual cluster snapshots that are public and
|
2344
|
-
# can be copied or restored by any account, and
|
2345
|
-
# default is `false`.
|
2394
|
+
# can be copied or restored by any Amazon Web Services account, and
|
2395
|
+
# otherwise `false`. The default is `false`.
|
2346
2396
|
#
|
2347
2397
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2348
2398
|
#
|
@@ -2508,6 +2558,7 @@ module Aws::DocDB
|
|
2508
2558
|
# resp.db_clusters[0].associated_roles #=> Array
|
2509
2559
|
# resp.db_clusters[0].associated_roles[0].role_arn #=> String
|
2510
2560
|
# resp.db_clusters[0].associated_roles[0].status #=> String
|
2561
|
+
# resp.db_clusters[0].clone_group_id #=> String
|
2511
2562
|
# resp.db_clusters[0].cluster_create_time #=> Time
|
2512
2563
|
# resp.db_clusters[0].enabled_cloudwatch_logs_exports #=> Array
|
2513
2564
|
# resp.db_clusters[0].enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -2750,6 +2801,7 @@ module Aws::DocDB
|
|
2750
2801
|
# resp.db_instances[0].kms_key_id #=> String
|
2751
2802
|
# resp.db_instances[0].dbi_resource_id #=> String
|
2752
2803
|
# resp.db_instances[0].ca_certificate_identifier #=> String
|
2804
|
+
# resp.db_instances[0].copy_tags_to_snapshot #=> Boolean
|
2753
2805
|
# resp.db_instances[0].promotion_tier #=> Integer
|
2754
2806
|
# resp.db_instances[0].db_instance_arn #=> String
|
2755
2807
|
# resp.db_instances[0].enabled_cloudwatch_logs_exports #=> Array
|
@@ -3467,6 +3519,7 @@ module Aws::DocDB
|
|
3467
3519
|
# resp.db_cluster.associated_roles #=> Array
|
3468
3520
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
3469
3521
|
# resp.db_cluster.associated_roles[0].status #=> String
|
3522
|
+
# resp.db_cluster.clone_group_id #=> String
|
3470
3523
|
# resp.db_cluster.cluster_create_time #=> Time
|
3471
3524
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
3472
3525
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -3605,7 +3658,7 @@ module Aws::DocDB
|
|
3605
3658
|
# parameter.
|
3606
3659
|
#
|
3607
3660
|
# The default is a 30-minute window selected at random from an 8-hour
|
3608
|
-
# block of time for each Region.
|
3661
|
+
# block of time for each Amazon Web Services Region.
|
3609
3662
|
#
|
3610
3663
|
# Constraints:
|
3611
3664
|
#
|
@@ -3624,7 +3677,8 @@ module Aws::DocDB
|
|
3624
3677
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
3625
3678
|
#
|
3626
3679
|
# The default is a 30-minute window selected at random from an 8-hour
|
3627
|
-
# block of time for each Region, occurring on a
|
3680
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
3681
|
+
# random day of the week.
|
3628
3682
|
#
|
3629
3683
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
3630
3684
|
#
|
@@ -3712,6 +3766,7 @@ module Aws::DocDB
|
|
3712
3766
|
# resp.db_cluster.associated_roles #=> Array
|
3713
3767
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
3714
3768
|
# resp.db_cluster.associated_roles[0].status #=> String
|
3769
|
+
# resp.db_cluster.clone_group_id #=> String
|
3715
3770
|
# resp.db_cluster.cluster_create_time #=> Time
|
3716
3771
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
3717
3772
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -3792,17 +3847,19 @@ module Aws::DocDB
|
|
3792
3847
|
# Adds an attribute and values to, or removes an attribute and values
|
3793
3848
|
# from, a manual cluster snapshot.
|
3794
3849
|
#
|
3795
|
-
# To share a manual cluster snapshot with other
|
3796
|
-
# `restore` as the `AttributeName`, and use the
|
3797
|
-
# to add a list of IDs of the
|
3798
|
-
#
|
3799
|
-
#
|
3800
|
-
#
|
3801
|
-
#
|
3802
|
-
#
|
3803
|
-
#
|
3804
|
-
#
|
3805
|
-
#
|
3850
|
+
# To share a manual cluster snapshot with other Amazon Web Services
|
3851
|
+
# accounts, specify `restore` as the `AttributeName`, and use the
|
3852
|
+
# `ValuesToAdd` parameter to add a list of IDs of the Amazon Web
|
3853
|
+
# Services accounts that are authorized to restore the manual cluster
|
3854
|
+
# snapshot. Use the value `all` to make the manual cluster snapshot
|
3855
|
+
# public, which means that it can be copied or restored by all Amazon
|
3856
|
+
# Web Services accounts. Do not add the `all` value for any manual
|
3857
|
+
# cluster snapshots that contain private information that you don't
|
3858
|
+
# want available to all Amazon Web Services accounts. If a manual
|
3859
|
+
# cluster snapshot is encrypted, it can be shared, but only by
|
3860
|
+
# specifying a list of authorized Amazon Web Services account IDs for
|
3861
|
+
# the `ValuesToAdd` parameter. You can't use `all` as a value for that
|
3862
|
+
# parameter in this case.
|
3806
3863
|
#
|
3807
3864
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
3808
3865
|
# The identifier for the cluster snapshot to modify the attributes for.
|
@@ -3810,29 +3867,31 @@ module Aws::DocDB
|
|
3810
3867
|
# @option params [required, String] :attribute_name
|
3811
3868
|
# The name of the cluster snapshot attribute to modify.
|
3812
3869
|
#
|
3813
|
-
# To manage authorization for other accounts to copy
|
3814
|
-
# cluster snapshot, set this value to `restore`.
|
3870
|
+
# To manage authorization for other Amazon Web Services accounts to copy
|
3871
|
+
# or restore a manual cluster snapshot, set this value to `restore`.
|
3815
3872
|
#
|
3816
3873
|
# @option params [Array<String>] :values_to_add
|
3817
3874
|
# A list of cluster snapshot attributes to add to the attribute
|
3818
3875
|
# specified by `AttributeName`.
|
3819
3876
|
#
|
3820
|
-
# To authorize other accounts to copy or restore a
|
3821
|
-
# snapshot, set this list to include one or more
|
3822
|
-
#
|
3823
|
-
#
|
3824
|
-
#
|
3825
|
-
# to all
|
3877
|
+
# To authorize other Amazon Web Services accounts to copy or restore a
|
3878
|
+
# manual cluster snapshot, set this list to include one or more Amazon
|
3879
|
+
# Web Services account IDs. To make the manual cluster snapshot
|
3880
|
+
# restorable by any Amazon Web Services account, set it to `all`. Do not
|
3881
|
+
# add the `all` value for any manual cluster snapshots that contain
|
3882
|
+
# private information that you don't want to be available to all Amazon
|
3883
|
+
# Web Services accounts.
|
3826
3884
|
#
|
3827
3885
|
# @option params [Array<String>] :values_to_remove
|
3828
3886
|
# A list of cluster snapshot attributes to remove from the attribute
|
3829
3887
|
# specified by `AttributeName`.
|
3830
3888
|
#
|
3831
|
-
# To remove authorization for other accounts to copy
|
3832
|
-
# cluster snapshot, set this list to include one or
|
3833
|
-
# identifiers. To remove authorization
|
3834
|
-
#
|
3835
|
-
#
|
3889
|
+
# To remove authorization for other Amazon Web Services accounts to copy
|
3890
|
+
# or restore a manual cluster snapshot, set this list to include one or
|
3891
|
+
# more Amazon Web Services account identifiers. To remove authorization
|
3892
|
+
# for any Amazon Web Services account to copy or restore the cluster
|
3893
|
+
# snapshot, set it to `all` . If you specify `all`, an Amazon Web
|
3894
|
+
# Services account whose account ID is explicitly added to the `restore`
|
3836
3895
|
# attribute can still copy or restore a manual cluster snapshot.
|
3837
3896
|
#
|
3838
3897
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3880,7 +3939,8 @@ module Aws::DocDB
|
|
3880
3939
|
#
|
3881
3940
|
# @option params [String] :db_instance_class
|
3882
3941
|
# The new compute and memory capacity of the instance; for example,
|
3883
|
-
# `db.r5.large`. Not all instance classes are available in all
|
3942
|
+
# `db.r5.large`. Not all instance classes are available in all Amazon
|
3943
|
+
# Web Services Regions.
|
3884
3944
|
#
|
3885
3945
|
# If you modify the instance class, an outage occurs during the change.
|
3886
3946
|
# The change is applied during the next maintenance window, unless
|
@@ -3944,6 +4004,10 @@ module Aws::DocDB
|
|
3944
4004
|
# Indicates the certificate that needs to be associated with the
|
3945
4005
|
# instance.
|
3946
4006
|
#
|
4007
|
+
# @option params [Boolean] :copy_tags_to_snapshot
|
4008
|
+
# A value that indicates whether to copy all tags from the DB instance
|
4009
|
+
# to snapshots of the DB instance. By default, tags are not copied.
|
4010
|
+
#
|
3947
4011
|
# @option params [Integer] :promotion_tier
|
3948
4012
|
# A value that specifies the order in which an Amazon DocumentDB replica
|
3949
4013
|
# is promoted to the primary instance after a failure of the existing
|
@@ -3953,6 +4017,27 @@ module Aws::DocDB
|
|
3953
4017
|
#
|
3954
4018
|
# Valid values: 0-15
|
3955
4019
|
#
|
4020
|
+
# @option params [Boolean] :enable_performance_insights
|
4021
|
+
# A value that indicates whether to enable Performance Insights for the
|
4022
|
+
# DB Instance. For more information, see [Using Amazon Performance
|
4023
|
+
# Insights][1].
|
4024
|
+
#
|
4025
|
+
#
|
4026
|
+
#
|
4027
|
+
# [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html
|
4028
|
+
#
|
4029
|
+
# @option params [String] :performance_insights_kms_key_id
|
4030
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
4031
|
+
#
|
4032
|
+
# The KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
4033
|
+
# name for the KMS key.
|
4034
|
+
#
|
4035
|
+
# If you do not specify a value for PerformanceInsightsKMSKeyId, then
|
4036
|
+
# Amazon DocumentDB uses your default KMS key. There is a default KMS
|
4037
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
4038
|
+
# account has a different default KMS key for each Amazon Web Services
|
4039
|
+
# region.
|
4040
|
+
#
|
3956
4041
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3957
4042
|
#
|
3958
4043
|
# * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -3967,7 +4052,10 @@ module Aws::DocDB
|
|
3967
4052
|
# auto_minor_version_upgrade: false,
|
3968
4053
|
# new_db_instance_identifier: "String",
|
3969
4054
|
# ca_certificate_identifier: "String",
|
4055
|
+
# copy_tags_to_snapshot: false,
|
3970
4056
|
# promotion_tier: 1,
|
4057
|
+
# enable_performance_insights: false,
|
4058
|
+
# performance_insights_kms_key_id: "String",
|
3971
4059
|
# })
|
3972
4060
|
#
|
3973
4061
|
# @example Response structure
|
@@ -4027,6 +4115,7 @@ module Aws::DocDB
|
|
4027
4115
|
# resp.db_instance.kms_key_id #=> String
|
4028
4116
|
# resp.db_instance.dbi_resource_id #=> String
|
4029
4117
|
# resp.db_instance.ca_certificate_identifier #=> String
|
4118
|
+
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
4030
4119
|
# resp.db_instance.promotion_tier #=> Integer
|
4031
4120
|
# resp.db_instance.db_instance_arn #=> String
|
4032
4121
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
@@ -4042,7 +4131,8 @@ module Aws::DocDB
|
|
4042
4131
|
end
|
4043
4132
|
|
4044
4133
|
# Modifies an existing subnet group. subnet groups must contain at least
|
4045
|
-
# one subnet in at least two Availability Zones in the
|
4134
|
+
# one subnet in at least two Availability Zones in the Amazon Web
|
4135
|
+
# Services Region.
|
4046
4136
|
#
|
4047
4137
|
# @option params [required, String] :db_subnet_group_name
|
4048
4138
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -4322,6 +4412,7 @@ module Aws::DocDB
|
|
4322
4412
|
# resp.db_instance.kms_key_id #=> String
|
4323
4413
|
# resp.db_instance.dbi_resource_id #=> String
|
4324
4414
|
# resp.db_instance.ca_certificate_identifier #=> String
|
4415
|
+
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
4325
4416
|
# resp.db_instance.promotion_tier #=> Integer
|
4326
4417
|
# resp.db_instance.db_instance_arn #=> String
|
4327
4418
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
@@ -4604,10 +4695,10 @@ module Aws::DocDB
|
|
4604
4695
|
# a DB snapshot or cluster snapshot.
|
4605
4696
|
#
|
4606
4697
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4607
|
-
# encryption key. If you are restoring a cluster with the same
|
4608
|
-
# that owns the KMS encryption key used to encrypt
|
4609
|
-
# you can use the KMS key alias instead of the ARN
|
4610
|
-
# encryption key.
|
4698
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
4699
|
+
# Web Services account that owns the KMS encryption key used to encrypt
|
4700
|
+
# the new cluster, then you can use the KMS key alias instead of the ARN
|
4701
|
+
# for the KMS encryption key.
|
4611
4702
|
#
|
4612
4703
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4613
4704
|
# following occurs:
|
@@ -4695,6 +4786,7 @@ module Aws::DocDB
|
|
4695
4786
|
# resp.db_cluster.associated_roles #=> Array
|
4696
4787
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
4697
4788
|
# resp.db_cluster.associated_roles[0].status #=> String
|
4789
|
+
# resp.db_cluster.clone_group_id #=> String
|
4698
4790
|
# resp.db_cluster.cluster_create_time #=> Time
|
4699
4791
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
4700
4792
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -4727,6 +4819,22 @@ module Aws::DocDB
|
|
4727
4819
|
#
|
4728
4820
|
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
4729
4821
|
#
|
4822
|
+
# @option params [String] :restore_type
|
4823
|
+
# The type of restore to be performed. You can specify one of the
|
4824
|
+
# following values:
|
4825
|
+
#
|
4826
|
+
# * `full-copy` - The new DB cluster is restored as a full copy of the
|
4827
|
+
# source DB cluster.
|
4828
|
+
#
|
4829
|
+
# * `copy-on-write` - The new DB cluster is restored as a clone of the
|
4830
|
+
# source DB cluster.
|
4831
|
+
#
|
4832
|
+
# Constraints: You can't specify `copy-on-write` if the engine version
|
4833
|
+
# of the source DB cluster is earlier than 1.11.
|
4834
|
+
#
|
4835
|
+
# If you don't specify a `RestoreType` value, then the new DB cluster
|
4836
|
+
# is restored as a full copy of the source DB cluster.
|
4837
|
+
#
|
4730
4838
|
# @option params [required, String] :source_db_cluster_identifier
|
4731
4839
|
# The identifier of the source cluster from which to restore.
|
4732
4840
|
#
|
@@ -4791,10 +4899,10 @@ module Aws::DocDB
|
|
4791
4899
|
# an encrypted cluster.
|
4792
4900
|
#
|
4793
4901
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4794
|
-
# encryption key. If you are restoring a cluster with the same
|
4795
|
-
# that owns the KMS encryption key used to encrypt
|
4796
|
-
# you can use the KMS key alias instead of the ARN
|
4797
|
-
# encryption key.
|
4902
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
4903
|
+
# Web Services account that owns the KMS encryption key used to encrypt
|
4904
|
+
# the new cluster, then you can use the KMS key alias instead of the ARN
|
4905
|
+
# for the KMS encryption key.
|
4798
4906
|
#
|
4799
4907
|
# You can restore to a new cluster and encrypt the new cluster with an
|
4800
4908
|
# KMS key that is different from the KMS key used to encrypt the source
|
@@ -4831,6 +4939,7 @@ module Aws::DocDB
|
|
4831
4939
|
#
|
4832
4940
|
# resp = client.restore_db_cluster_to_point_in_time({
|
4833
4941
|
# db_cluster_identifier: "String", # required
|
4942
|
+
# restore_type: "String",
|
4834
4943
|
# source_db_cluster_identifier: "String", # required
|
4835
4944
|
# restore_to_time: Time.now,
|
4836
4945
|
# use_latest_restorable_time: false,
|
@@ -4888,6 +4997,7 @@ module Aws::DocDB
|
|
4888
4997
|
# resp.db_cluster.associated_roles #=> Array
|
4889
4998
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
4890
4999
|
# resp.db_cluster.associated_roles[0].status #=> String
|
5000
|
+
# resp.db_cluster.clone_group_id #=> String
|
4891
5001
|
# resp.db_cluster.cluster_create_time #=> Time
|
4892
5002
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
4893
5003
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -4964,6 +5074,7 @@ module Aws::DocDB
|
|
4964
5074
|
# resp.db_cluster.associated_roles #=> Array
|
4965
5075
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
4966
5076
|
# resp.db_cluster.associated_roles[0].status #=> String
|
5077
|
+
# resp.db_cluster.clone_group_id #=> String
|
4967
5078
|
# resp.db_cluster.cluster_create_time #=> Time
|
4968
5079
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
4969
5080
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -5040,6 +5151,7 @@ module Aws::DocDB
|
|
5040
5151
|
# resp.db_cluster.associated_roles #=> Array
|
5041
5152
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
5042
5153
|
# resp.db_cluster.associated_roles[0].status #=> String
|
5154
|
+
# resp.db_cluster.clone_group_id #=> String
|
5043
5155
|
# resp.db_cluster.cluster_create_time #=> Time
|
5044
5156
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
5045
5157
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -5067,7 +5179,7 @@ module Aws::DocDB
|
|
5067
5179
|
params: params,
|
5068
5180
|
config: config)
|
5069
5181
|
context[:gem_name] = 'aws-sdk-docdb'
|
5070
|
-
context[:gem_version] = '1.
|
5182
|
+
context[:gem_version] = '1.43.0'
|
5071
5183
|
Seahorse::Client::Request.new(handlers, context)
|
5072
5184
|
end
|
5073
5185
|
|