aws-sdk-docdb 1.41.0 → 1.44.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-docdb/client.rb +205 -98
- data/lib/aws-sdk-docdb/client_api.rb +9 -0
- data/lib/aws-sdk-docdb/types.rb +210 -100
- data/lib/aws-sdk-docdb.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-docdb/client.rb
CHANGED
@@ -513,12 +513,14 @@ module Aws::DocDB
|
|
513
513
|
#
|
514
514
|
# * Must specify a valid cluster parameter group.
|
515
515
|
#
|
516
|
-
# * If the source cluster parameter group is in the same
|
517
|
-
# copy, specify a valid parameter group
|
518
|
-
# `my-db-cluster-param-group`, or a valid
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
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.
|
520
|
+
#
|
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,
|
522
524
|
# `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
|
523
525
|
#
|
524
526
|
# @option params [required, String] :target_db_cluster_parameter_group_identifier
|
@@ -581,7 +583,8 @@ module Aws::DocDB
|
|
581
583
|
# To copy a cluster snapshot from a shared manual cluster snapshot,
|
582
584
|
# `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
|
583
585
|
# (ARN) of the shared cluster snapshot. You can only copy a shared DB
|
584
|
-
# cluster snapshot, whether encrypted or not, in the same
|
586
|
+
# cluster snapshot, whether encrypted or not, in the same Amazon Web
|
587
|
+
# Services Region.
|
585
588
|
#
|
586
589
|
# To cancel the copy operation after it is in progress, delete the
|
587
590
|
# target cluster snapshot identified by
|
@@ -596,11 +599,11 @@ module Aws::DocDB
|
|
596
599
|
#
|
597
600
|
# * Must specify a valid system snapshot in the *available* state.
|
598
601
|
#
|
599
|
-
# * If the source snapshot is in the same
|
600
|
-
# 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.
|
601
604
|
#
|
602
|
-
# * If the source snapshot is in a different
|
603
|
-
# 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.
|
604
607
|
#
|
605
608
|
# Example: `my-cluster-snapshot1`
|
606
609
|
#
|
@@ -623,50 +626,56 @@ module Aws::DocDB
|
|
623
626
|
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
624
627
|
# alias for the KMS encryption key.
|
625
628
|
#
|
626
|
-
# If you copy an encrypted cluster snapshot from your
|
627
|
-
# specify a value for `KmsKeyId` to encrypt
|
628
|
-
# encryption key. If you don't specify a value
|
629
|
-
# copy of the cluster snapshot is encrypted
|
630
|
-
# 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.
|
631
634
|
#
|
632
635
|
# If you copy an encrypted cluster snapshot that is shared from another
|
633
|
-
# account, then you must specify a value for
|
636
|
+
# Amazon Web Services account, then you must specify a value for
|
637
|
+
# `KmsKeyId`.
|
634
638
|
#
|
635
|
-
# To copy an encrypted cluster snapshot to another
|
636
|
-
# `KmsKeyId` to the KMS key ID that you want to use to
|
637
|
-
# of the cluster snapshot in the destination Region.
|
638
|
-
# are specific to the
|
639
|
-
# 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.
|
640
645
|
#
|
641
646
|
# If you copy an unencrypted cluster snapshot and specify a value for
|
642
647
|
# the `KmsKeyId` parameter, an error is returned.
|
643
648
|
#
|
644
649
|
# @option params [String] :pre_signed_url
|
645
650
|
# The URL that contains a Signature Version 4 signed request for
|
646
|
-
# the`CopyDBClusterSnapshot` API action in the
|
647
|
-
# source cluster snapshot to copy. You must use
|
648
|
-
# 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.
|
649
655
|
#
|
650
656
|
# If you are using an Amazon Web Services SDK tool or the CLI, you can
|
651
657
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
652
658
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
653
659
|
# autogenerates a pre-signed URL that is a valid request for the
|
654
|
-
# operation that can be executed in the source
|
660
|
+
# operation that can be executed in the source Amazon Web Services
|
661
|
+
# Region.
|
655
662
|
#
|
656
663
|
# The presigned URL must be a valid request for the
|
657
664
|
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
658
|
-
# Region that contains the cluster snapshot to be
|
659
|
-
# 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:
|
660
668
|
#
|
661
669
|
# * `SourceRegion` - The ID of the region that contains the snapshot to
|
662
670
|
# be copied.
|
663
671
|
#
|
664
672
|
# * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
|
665
673
|
# encrypted cluster snapshot to be copied. This identifier must be in
|
666
|
-
# the Amazon Resource Name (ARN) format for the source
|
667
|
-
# example, if you are copying an encrypted
|
668
|
-
# us-east-1 Region, then
|
669
|
-
# 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:
|
670
679
|
# `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
|
671
680
|
#
|
672
681
|
# * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
|
@@ -822,7 +831,7 @@ module Aws::DocDB
|
|
822
831
|
# parameter.
|
823
832
|
#
|
824
833
|
# The default is a 30-minute window selected at random from an 8-hour
|
825
|
-
# block of time for each Region.
|
834
|
+
# block of time for each Amazon Web Services Region.
|
826
835
|
#
|
827
836
|
# Constraints:
|
828
837
|
#
|
@@ -841,7 +850,8 @@ module Aws::DocDB
|
|
841
850
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
842
851
|
#
|
843
852
|
# The default is a 30-minute window selected at random from an 8-hour
|
844
|
-
# 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.
|
845
855
|
#
|
846
856
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
847
857
|
#
|
@@ -857,10 +867,10 @@ module Aws::DocDB
|
|
857
867
|
# The KMS key identifier for an encrypted cluster.
|
858
868
|
#
|
859
869
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
860
|
-
# encryption key. If you are creating a cluster using the same
|
861
|
-
# that owns the KMS encryption key that is used to
|
862
|
-
# cluster, you can use the KMS key alias instead of the
|
863
|
-
# 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.
|
864
874
|
#
|
865
875
|
# If an encryption key is not specified in `KmsKeyId`\:
|
866
876
|
#
|
@@ -869,8 +879,9 @@ module Aws::DocDB
|
|
869
879
|
#
|
870
880
|
# ^
|
871
881
|
#
|
872
|
-
# KMS creates the default encryption key for your
|
873
|
-
#
|
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.
|
874
885
|
#
|
875
886
|
# @option params [String] :pre_signed_url
|
876
887
|
# Not currently supported.
|
@@ -974,6 +985,7 @@ module Aws::DocDB
|
|
974
985
|
# resp.db_cluster.associated_roles #=> Array
|
975
986
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
976
987
|
# resp.db_cluster.associated_roles[0].status #=> String
|
988
|
+
# resp.db_cluster.clone_group_id #=> String
|
977
989
|
# resp.db_cluster.cluster_create_time #=> Time
|
978
990
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
979
991
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -1175,7 +1187,7 @@ module Aws::DocDB
|
|
1175
1187
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
1176
1188
|
#
|
1177
1189
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1178
|
-
# Region.
|
1190
|
+
# Amazon Web Services Region.
|
1179
1191
|
#
|
1180
1192
|
# Example: `us-east-1d`
|
1181
1193
|
#
|
@@ -1186,7 +1198,8 @@ module Aws::DocDB
|
|
1186
1198
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1187
1199
|
#
|
1188
1200
|
# The default is a 30-minute window selected at random from an 8-hour
|
1189
|
-
# 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.
|
1190
1203
|
#
|
1191
1204
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
1192
1205
|
#
|
@@ -1205,6 +1218,10 @@ module Aws::DocDB
|
|
1205
1218
|
# @option params [required, String] :db_cluster_identifier
|
1206
1219
|
# The identifier of the cluster that the instance will belong to.
|
1207
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
|
+
#
|
1208
1225
|
# @option params [Integer] :promotion_tier
|
1209
1226
|
# A value that specifies the order in which an Amazon DocumentDB replica
|
1210
1227
|
# is promoted to the primary instance after a failure of the existing
|
@@ -1214,6 +1231,27 @@ module Aws::DocDB
|
|
1214
1231
|
#
|
1215
1232
|
# Valid values: 0-15
|
1216
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
|
+
#
|
1217
1255
|
# @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1218
1256
|
#
|
1219
1257
|
# * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -1234,7 +1272,10 @@ module Aws::DocDB
|
|
1234
1272
|
# },
|
1235
1273
|
# ],
|
1236
1274
|
# db_cluster_identifier: "String", # required
|
1275
|
+
# copy_tags_to_snapshot: false,
|
1237
1276
|
# promotion_tier: 1,
|
1277
|
+
# enable_performance_insights: false,
|
1278
|
+
# performance_insights_kms_key_id: "String",
|
1238
1279
|
# })
|
1239
1280
|
#
|
1240
1281
|
# @example Response structure
|
@@ -1294,6 +1335,7 @@ module Aws::DocDB
|
|
1294
1335
|
# resp.db_instance.kms_key_id #=> String
|
1295
1336
|
# resp.db_instance.dbi_resource_id #=> String
|
1296
1337
|
# resp.db_instance.ca_certificate_identifier #=> String
|
1338
|
+
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
1297
1339
|
# resp.db_instance.promotion_tier #=> Integer
|
1298
1340
|
# resp.db_instance.db_instance_arn #=> String
|
1299
1341
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
@@ -1309,7 +1351,8 @@ module Aws::DocDB
|
|
1309
1351
|
end
|
1310
1352
|
|
1311
1353
|
# Creates a new subnet group. subnet groups must contain at least one
|
1312
|
-
# subnet in at least two Availability Zones in the
|
1354
|
+
# subnet in at least two Availability Zones in the Amazon Web Services
|
1355
|
+
# Region.
|
1313
1356
|
#
|
1314
1357
|
# @option params [required, String] :db_subnet_group_name
|
1315
1358
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -1492,11 +1535,12 @@ module Aws::DocDB
|
|
1492
1535
|
end
|
1493
1536
|
|
1494
1537
|
# Creates an Amazon DocumentDB global cluster that can span multiple
|
1495
|
-
# multiple Regions. The global cluster contains one
|
1496
|
-
# read-write capability, and up-to give read-only
|
1497
|
-
# Global clusters uses storage-based fast
|
1498
|
-
# with latencies less than one second, using
|
1499
|
-
# 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.
|
1500
1544
|
#
|
1501
1545
|
#
|
1502
1546
|
#
|
@@ -1673,6 +1717,7 @@ module Aws::DocDB
|
|
1673
1717
|
# resp.db_cluster.associated_roles #=> Array
|
1674
1718
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
1675
1719
|
# resp.db_cluster.associated_roles[0].status #=> String
|
1720
|
+
# resp.db_cluster.clone_group_id #=> String
|
1676
1721
|
# resp.db_cluster.cluster_create_time #=> Time
|
1677
1722
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
1678
1723
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -1850,6 +1895,7 @@ module Aws::DocDB
|
|
1850
1895
|
# resp.db_instance.kms_key_id #=> String
|
1851
1896
|
# resp.db_instance.dbi_resource_id #=> String
|
1852
1897
|
# resp.db_instance.ca_certificate_identifier #=> String
|
1898
|
+
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
1853
1899
|
# resp.db_instance.promotion_tier #=> Integer
|
1854
1900
|
# resp.db_instance.db_instance_arn #=> String
|
1855
1901
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
@@ -1990,7 +2036,7 @@ module Aws::DocDB
|
|
1990
2036
|
end
|
1991
2037
|
|
1992
2038
|
# Returns a list of certificate authority (CA) certificates provided by
|
1993
|
-
# Amazon DocumentDB for this account.
|
2039
|
+
# Amazon DocumentDB for this Amazon Web Services account.
|
1994
2040
|
#
|
1995
2041
|
# @option params [String] :certificate_identifier
|
1996
2042
|
# The user-supplied certificate identifier. If this parameter is
|
@@ -2225,12 +2271,13 @@ module Aws::DocDB
|
|
2225
2271
|
# Returns a list of cluster snapshot attribute names and values for a
|
2226
2272
|
# manual DB cluster snapshot.
|
2227
2273
|
#
|
2228
|
-
# When you share snapshots with other accounts,
|
2274
|
+
# When you share snapshots with other Amazon Web Services accounts,
|
2229
2275
|
# `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
|
2230
|
-
# and a list of IDs for the accounts that are
|
2231
|
-
# restore the manual cluster snapshot. If `all` is
|
2232
|
-
# of values for the `restore` attribute, then the
|
2233
|
-
# 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.
|
2234
2281
|
#
|
2235
2282
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
2236
2283
|
# The identifier for the cluster snapshot to describe the attributes
|
@@ -2295,13 +2342,13 @@ module Aws::DocDB
|
|
2295
2342
|
# the following values:
|
2296
2343
|
#
|
2297
2344
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2298
|
-
# has automatically created for your account.
|
2345
|
+
# has automatically created for your Amazon Web Services account.
|
2299
2346
|
#
|
2300
2347
|
# * `manual` - Return all cluster snapshots that you have manually
|
2301
|
-
# created for your account.
|
2348
|
+
# created for your Amazon Web Services account.
|
2302
2349
|
#
|
2303
2350
|
# * `shared` - Return all manual cluster snapshots that have been shared
|
2304
|
-
# to your account.
|
2351
|
+
# to your Amazon Web Services account.
|
2305
2352
|
#
|
2306
2353
|
# * `public` - Return all cluster snapshots that have been marked as
|
2307
2354
|
# public.
|
@@ -2338,13 +2385,14 @@ module Aws::DocDB
|
|
2338
2385
|
#
|
2339
2386
|
# @option params [Boolean] :include_shared
|
2340
2387
|
# Set to `true` to include shared manual cluster snapshots from other
|
2341
|
-
# accounts that this
|
2342
|
-
# 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`.
|
2343
2391
|
#
|
2344
2392
|
# @option params [Boolean] :include_public
|
2345
2393
|
# Set to `true` to include manual cluster snapshots that are public and
|
2346
|
-
# can be copied or restored by any account, and
|
2347
|
-
# default is `false`.
|
2394
|
+
# can be copied or restored by any Amazon Web Services account, and
|
2395
|
+
# otherwise `false`. The default is `false`.
|
2348
2396
|
#
|
2349
2397
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2350
2398
|
#
|
@@ -2510,6 +2558,7 @@ module Aws::DocDB
|
|
2510
2558
|
# resp.db_clusters[0].associated_roles #=> Array
|
2511
2559
|
# resp.db_clusters[0].associated_roles[0].role_arn #=> String
|
2512
2560
|
# resp.db_clusters[0].associated_roles[0].status #=> String
|
2561
|
+
# resp.db_clusters[0].clone_group_id #=> String
|
2513
2562
|
# resp.db_clusters[0].cluster_create_time #=> Time
|
2514
2563
|
# resp.db_clusters[0].enabled_cloudwatch_logs_exports #=> Array
|
2515
2564
|
# resp.db_clusters[0].enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -2752,6 +2801,7 @@ module Aws::DocDB
|
|
2752
2801
|
# resp.db_instances[0].kms_key_id #=> String
|
2753
2802
|
# resp.db_instances[0].dbi_resource_id #=> String
|
2754
2803
|
# resp.db_instances[0].ca_certificate_identifier #=> String
|
2804
|
+
# resp.db_instances[0].copy_tags_to_snapshot #=> Boolean
|
2755
2805
|
# resp.db_instances[0].promotion_tier #=> Integer
|
2756
2806
|
# resp.db_instances[0].db_instance_arn #=> String
|
2757
2807
|
# resp.db_instances[0].enabled_cloudwatch_logs_exports #=> Array
|
@@ -3469,6 +3519,7 @@ module Aws::DocDB
|
|
3469
3519
|
# resp.db_cluster.associated_roles #=> Array
|
3470
3520
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
3471
3521
|
# resp.db_cluster.associated_roles[0].status #=> String
|
3522
|
+
# resp.db_cluster.clone_group_id #=> String
|
3472
3523
|
# resp.db_cluster.cluster_create_time #=> Time
|
3473
3524
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
3474
3525
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -3607,7 +3658,7 @@ module Aws::DocDB
|
|
3607
3658
|
# parameter.
|
3608
3659
|
#
|
3609
3660
|
# The default is a 30-minute window selected at random from an 8-hour
|
3610
|
-
# block of time for each Region.
|
3661
|
+
# block of time for each Amazon Web Services Region.
|
3611
3662
|
#
|
3612
3663
|
# Constraints:
|
3613
3664
|
#
|
@@ -3626,7 +3677,8 @@ module Aws::DocDB
|
|
3626
3677
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
3627
3678
|
#
|
3628
3679
|
# The default is a 30-minute window selected at random from an 8-hour
|
3629
|
-
# 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.
|
3630
3682
|
#
|
3631
3683
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
3632
3684
|
#
|
@@ -3714,6 +3766,7 @@ module Aws::DocDB
|
|
3714
3766
|
# resp.db_cluster.associated_roles #=> Array
|
3715
3767
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
3716
3768
|
# resp.db_cluster.associated_roles[0].status #=> String
|
3769
|
+
# resp.db_cluster.clone_group_id #=> String
|
3717
3770
|
# resp.db_cluster.cluster_create_time #=> Time
|
3718
3771
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
3719
3772
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -3794,17 +3847,19 @@ module Aws::DocDB
|
|
3794
3847
|
# Adds an attribute and values to, or removes an attribute and values
|
3795
3848
|
# from, a manual cluster snapshot.
|
3796
3849
|
#
|
3797
|
-
# To share a manual cluster snapshot with other
|
3798
|
-
# `restore` as the `AttributeName`, and use the
|
3799
|
-
# to add a list of IDs of the
|
3800
|
-
#
|
3801
|
-
#
|
3802
|
-
#
|
3803
|
-
#
|
3804
|
-
#
|
3805
|
-
#
|
3806
|
-
#
|
3807
|
-
#
|
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.
|
3808
3863
|
#
|
3809
3864
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
3810
3865
|
# The identifier for the cluster snapshot to modify the attributes for.
|
@@ -3812,29 +3867,31 @@ module Aws::DocDB
|
|
3812
3867
|
# @option params [required, String] :attribute_name
|
3813
3868
|
# The name of the cluster snapshot attribute to modify.
|
3814
3869
|
#
|
3815
|
-
# To manage authorization for other accounts to copy
|
3816
|
-
# 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`.
|
3817
3872
|
#
|
3818
3873
|
# @option params [Array<String>] :values_to_add
|
3819
3874
|
# A list of cluster snapshot attributes to add to the attribute
|
3820
3875
|
# specified by `AttributeName`.
|
3821
3876
|
#
|
3822
|
-
# To authorize other accounts to copy or restore a
|
3823
|
-
# snapshot, set this list to include one or more
|
3824
|
-
#
|
3825
|
-
#
|
3826
|
-
#
|
3827
|
-
# 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.
|
3828
3884
|
#
|
3829
3885
|
# @option params [Array<String>] :values_to_remove
|
3830
3886
|
# A list of cluster snapshot attributes to remove from the attribute
|
3831
3887
|
# specified by `AttributeName`.
|
3832
3888
|
#
|
3833
|
-
# To remove authorization for other accounts to copy
|
3834
|
-
# cluster snapshot, set this list to include one or
|
3835
|
-
# identifiers. To remove authorization
|
3836
|
-
#
|
3837
|
-
#
|
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`
|
3838
3895
|
# attribute can still copy or restore a manual cluster snapshot.
|
3839
3896
|
#
|
3840
3897
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3882,7 +3939,8 @@ module Aws::DocDB
|
|
3882
3939
|
#
|
3883
3940
|
# @option params [String] :db_instance_class
|
3884
3941
|
# The new compute and memory capacity of the instance; for example,
|
3885
|
-
# `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.
|
3886
3944
|
#
|
3887
3945
|
# If you modify the instance class, an outage occurs during the change.
|
3888
3946
|
# The change is applied during the next maintenance window, unless
|
@@ -3946,6 +4004,10 @@ module Aws::DocDB
|
|
3946
4004
|
# Indicates the certificate that needs to be associated with the
|
3947
4005
|
# instance.
|
3948
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
|
+
#
|
3949
4011
|
# @option params [Integer] :promotion_tier
|
3950
4012
|
# A value that specifies the order in which an Amazon DocumentDB replica
|
3951
4013
|
# is promoted to the primary instance after a failure of the existing
|
@@ -3955,6 +4017,27 @@ module Aws::DocDB
|
|
3955
4017
|
#
|
3956
4018
|
# Valid values: 0-15
|
3957
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
|
+
#
|
3958
4041
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3959
4042
|
#
|
3960
4043
|
# * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -3969,7 +4052,10 @@ module Aws::DocDB
|
|
3969
4052
|
# auto_minor_version_upgrade: false,
|
3970
4053
|
# new_db_instance_identifier: "String",
|
3971
4054
|
# ca_certificate_identifier: "String",
|
4055
|
+
# copy_tags_to_snapshot: false,
|
3972
4056
|
# promotion_tier: 1,
|
4057
|
+
# enable_performance_insights: false,
|
4058
|
+
# performance_insights_kms_key_id: "String",
|
3973
4059
|
# })
|
3974
4060
|
#
|
3975
4061
|
# @example Response structure
|
@@ -4029,6 +4115,7 @@ module Aws::DocDB
|
|
4029
4115
|
# resp.db_instance.kms_key_id #=> String
|
4030
4116
|
# resp.db_instance.dbi_resource_id #=> String
|
4031
4117
|
# resp.db_instance.ca_certificate_identifier #=> String
|
4118
|
+
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
4032
4119
|
# resp.db_instance.promotion_tier #=> Integer
|
4033
4120
|
# resp.db_instance.db_instance_arn #=> String
|
4034
4121
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
@@ -4044,7 +4131,8 @@ module Aws::DocDB
|
|
4044
4131
|
end
|
4045
4132
|
|
4046
4133
|
# Modifies an existing subnet group. subnet groups must contain at least
|
4047
|
-
# 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.
|
4048
4136
|
#
|
4049
4137
|
# @option params [required, String] :db_subnet_group_name
|
4050
4138
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -4324,6 +4412,7 @@ module Aws::DocDB
|
|
4324
4412
|
# resp.db_instance.kms_key_id #=> String
|
4325
4413
|
# resp.db_instance.dbi_resource_id #=> String
|
4326
4414
|
# resp.db_instance.ca_certificate_identifier #=> String
|
4415
|
+
# resp.db_instance.copy_tags_to_snapshot #=> Boolean
|
4327
4416
|
# resp.db_instance.promotion_tier #=> Integer
|
4328
4417
|
# resp.db_instance.db_instance_arn #=> String
|
4329
4418
|
# resp.db_instance.enabled_cloudwatch_logs_exports #=> Array
|
@@ -4606,10 +4695,10 @@ module Aws::DocDB
|
|
4606
4695
|
# a DB snapshot or cluster snapshot.
|
4607
4696
|
#
|
4608
4697
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4609
|
-
# encryption key. If you are restoring a cluster with the same
|
4610
|
-
# that owns the KMS encryption key used to encrypt
|
4611
|
-
# you can use the KMS key alias instead of the ARN
|
4612
|
-
# 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.
|
4613
4702
|
#
|
4614
4703
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4615
4704
|
# following occurs:
|
@@ -4697,6 +4786,7 @@ module Aws::DocDB
|
|
4697
4786
|
# resp.db_cluster.associated_roles #=> Array
|
4698
4787
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
4699
4788
|
# resp.db_cluster.associated_roles[0].status #=> String
|
4789
|
+
# resp.db_cluster.clone_group_id #=> String
|
4700
4790
|
# resp.db_cluster.cluster_create_time #=> Time
|
4701
4791
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
4702
4792
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -4729,6 +4819,19 @@ module Aws::DocDB
|
|
4729
4819
|
#
|
4730
4820
|
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
4731
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
|
+
# If you don't specify a `RestoreType` value, then the new DB cluster
|
4833
|
+
# is restored as a full copy of the source DB cluster.
|
4834
|
+
#
|
4732
4835
|
# @option params [required, String] :source_db_cluster_identifier
|
4733
4836
|
# The identifier of the source cluster from which to restore.
|
4734
4837
|
#
|
@@ -4793,10 +4896,10 @@ module Aws::DocDB
|
|
4793
4896
|
# an encrypted cluster.
|
4794
4897
|
#
|
4795
4898
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4796
|
-
# encryption key. If you are restoring a cluster with the same
|
4797
|
-
# that owns the KMS encryption key used to encrypt
|
4798
|
-
# you can use the KMS key alias instead of the ARN
|
4799
|
-
# encryption key.
|
4899
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
4900
|
+
# Web Services account that owns the KMS encryption key used to encrypt
|
4901
|
+
# the new cluster, then you can use the KMS key alias instead of the ARN
|
4902
|
+
# for the KMS encryption key.
|
4800
4903
|
#
|
4801
4904
|
# You can restore to a new cluster and encrypt the new cluster with an
|
4802
4905
|
# KMS key that is different from the KMS key used to encrypt the source
|
@@ -4833,6 +4936,7 @@ module Aws::DocDB
|
|
4833
4936
|
#
|
4834
4937
|
# resp = client.restore_db_cluster_to_point_in_time({
|
4835
4938
|
# db_cluster_identifier: "String", # required
|
4939
|
+
# restore_type: "String",
|
4836
4940
|
# source_db_cluster_identifier: "String", # required
|
4837
4941
|
# restore_to_time: Time.now,
|
4838
4942
|
# use_latest_restorable_time: false,
|
@@ -4890,6 +4994,7 @@ module Aws::DocDB
|
|
4890
4994
|
# resp.db_cluster.associated_roles #=> Array
|
4891
4995
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
4892
4996
|
# resp.db_cluster.associated_roles[0].status #=> String
|
4997
|
+
# resp.db_cluster.clone_group_id #=> String
|
4893
4998
|
# resp.db_cluster.cluster_create_time #=> Time
|
4894
4999
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
4895
5000
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -4966,6 +5071,7 @@ module Aws::DocDB
|
|
4966
5071
|
# resp.db_cluster.associated_roles #=> Array
|
4967
5072
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
4968
5073
|
# resp.db_cluster.associated_roles[0].status #=> String
|
5074
|
+
# resp.db_cluster.clone_group_id #=> String
|
4969
5075
|
# resp.db_cluster.cluster_create_time #=> Time
|
4970
5076
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
4971
5077
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -5042,6 +5148,7 @@ module Aws::DocDB
|
|
5042
5148
|
# resp.db_cluster.associated_roles #=> Array
|
5043
5149
|
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
5044
5150
|
# resp.db_cluster.associated_roles[0].status #=> String
|
5151
|
+
# resp.db_cluster.clone_group_id #=> String
|
5045
5152
|
# resp.db_cluster.cluster_create_time #=> Time
|
5046
5153
|
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
5047
5154
|
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
@@ -5069,7 +5176,7 @@ module Aws::DocDB
|
|
5069
5176
|
params: params,
|
5070
5177
|
config: config)
|
5071
5178
|
context[:gem_name] = 'aws-sdk-docdb'
|
5072
|
-
context[:gem_version] = '1.
|
5179
|
+
context[:gem_version] = '1.44.0'
|
5073
5180
|
Seahorse::Client::Request.new(handlers, context)
|
5074
5181
|
end
|
5075
5182
|
|