aws-sdk-docdb 1.39.0 → 1.42.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 +170 -97
- data/lib/aws-sdk-docdb/client_api.rb +4 -0
- data/lib/aws-sdk-docdb/types.rb +169 -100
- data/lib/aws-sdk-docdb.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8405b51a695915280d12b05a70057653468a674936a9210fbb904d1f49288cd6
|
4
|
+
data.tar.gz: e2e5989daa62069b5d4a44e8d1548c63876f7089370180840ef1c16a7673dd21
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c3d3b18fe0f3f3ead121b71e452ab7153c33b64fab0331d2f623b27bba5f969bc1b3e461f8dfeadf2577bb09f70a953206f2d8405fccebedda9229d5db89ae47
|
7
|
+
data.tar.gz: efcd7881eb3d3cc555a07ab7f3c95e89a797294b9cf6b02b17c41c0d3548ba9918834400ed7c6ad2a816ec64d4c2d03bb80d216e649ffa68bbc6ca6d7afbcdfa
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.42.0 (2022-04-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added support to enable/disable performance insights when creating or modifying db instances
|
8
|
+
|
9
|
+
1.41.0 (2022-02-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.40.0 (2022-02-03)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
4
19
|
1.39.0 (2021-12-21)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.42.0
|
data/lib/aws-sdk-docdb/client.rb
CHANGED
@@ -27,7 +27,9 @@ 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'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
31
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
32
34
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
33
35
|
require 'aws-sdk-docdb/plugins/cross_region_copying.rb'
|
@@ -75,7 +77,9 @@ module Aws::DocDB
|
|
75
77
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
78
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
79
|
add_plugin(Aws::Plugins::HttpChecksum)
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
81
|
add_plugin(Aws::Plugins::DefaultsMode)
|
82
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
79
83
|
add_plugin(Aws::Plugins::SignatureV4)
|
80
84
|
add_plugin(Aws::Plugins::Protocols::Query)
|
81
85
|
add_plugin(Aws::DocDB::Plugins::CrossRegionCopying)
|
@@ -509,12 +513,14 @@ module Aws::DocDB
|
|
509
513
|
#
|
510
514
|
# * Must specify a valid cluster parameter group.
|
511
515
|
#
|
512
|
-
# * If the source cluster parameter group is in the same
|
513
|
-
# copy, specify a valid parameter group
|
514
|
-
# `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.
|
515
520
|
#
|
516
|
-
# * If the source parameter group is in a different
|
517
|
-
# 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,
|
518
524
|
# `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
|
519
525
|
#
|
520
526
|
# @option params [required, String] :target_db_cluster_parameter_group_identifier
|
@@ -577,7 +583,8 @@ module Aws::DocDB
|
|
577
583
|
# To copy a cluster snapshot from a shared manual cluster snapshot,
|
578
584
|
# `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
|
579
585
|
# (ARN) of the shared cluster snapshot. You can only copy a shared DB
|
580
|
-
# cluster snapshot, whether encrypted or not, in the same
|
586
|
+
# cluster snapshot, whether encrypted or not, in the same Amazon Web
|
587
|
+
# Services Region.
|
581
588
|
#
|
582
589
|
# To cancel the copy operation after it is in progress, delete the
|
583
590
|
# target cluster snapshot identified by
|
@@ -592,11 +599,11 @@ module Aws::DocDB
|
|
592
599
|
#
|
593
600
|
# * Must specify a valid system snapshot in the *available* state.
|
594
601
|
#
|
595
|
-
# * If the source snapshot is in the same
|
596
|
-
# 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.
|
597
604
|
#
|
598
|
-
# * If the source snapshot is in a different
|
599
|
-
# 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.
|
600
607
|
#
|
601
608
|
# Example: `my-cluster-snapshot1`
|
602
609
|
#
|
@@ -619,50 +626,56 @@ module Aws::DocDB
|
|
619
626
|
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
620
627
|
# alias for the KMS encryption key.
|
621
628
|
#
|
622
|
-
# If you copy an encrypted cluster snapshot from your
|
623
|
-
# specify a value for `KmsKeyId` to encrypt
|
624
|
-
# encryption key. If you don't specify a value
|
625
|
-
# copy of the cluster snapshot is encrypted
|
626
|
-
# 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.
|
627
634
|
#
|
628
635
|
# If you copy an encrypted cluster snapshot that is shared from another
|
629
|
-
# account, then you must specify a value for
|
636
|
+
# Amazon Web Services account, then you must specify a value for
|
637
|
+
# `KmsKeyId`.
|
630
638
|
#
|
631
|
-
# To copy an encrypted cluster snapshot to another
|
632
|
-
# `KmsKeyId` to the KMS key ID that you want to use to
|
633
|
-
# of the cluster snapshot in the destination Region.
|
634
|
-
# are specific to the
|
635
|
-
# 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.
|
636
645
|
#
|
637
646
|
# If you copy an unencrypted cluster snapshot and specify a value for
|
638
647
|
# the `KmsKeyId` parameter, an error is returned.
|
639
648
|
#
|
640
649
|
# @option params [String] :pre_signed_url
|
641
650
|
# The URL that contains a Signature Version 4 signed request for
|
642
|
-
# the`CopyDBClusterSnapshot` API action in the
|
643
|
-
# source cluster snapshot to copy. You must use
|
644
|
-
# 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.
|
645
655
|
#
|
646
656
|
# If you are using an Amazon Web Services SDK tool or the CLI, you can
|
647
657
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
648
658
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
649
659
|
# autogenerates a pre-signed URL that is a valid request for the
|
650
|
-
# operation that can be executed in the source
|
660
|
+
# operation that can be executed in the source Amazon Web Services
|
661
|
+
# Region.
|
651
662
|
#
|
652
663
|
# The presigned URL must be a valid request for the
|
653
664
|
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
654
|
-
# Region that contains the cluster snapshot to be
|
655
|
-
# 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:
|
656
668
|
#
|
657
669
|
# * `SourceRegion` - The ID of the region that contains the snapshot to
|
658
670
|
# be copied.
|
659
671
|
#
|
660
672
|
# * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
|
661
673
|
# encrypted cluster snapshot to be copied. This identifier must be in
|
662
|
-
# the Amazon Resource Name (ARN) format for the source
|
663
|
-
# example, if you are copying an encrypted
|
664
|
-
# us-east-1 Region, then
|
665
|
-
# 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:
|
666
679
|
# `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
|
667
680
|
#
|
668
681
|
# * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
|
@@ -818,7 +831,7 @@ module Aws::DocDB
|
|
818
831
|
# parameter.
|
819
832
|
#
|
820
833
|
# The default is a 30-minute window selected at random from an 8-hour
|
821
|
-
# block of time for each Region.
|
834
|
+
# block of time for each Amazon Web Services Region.
|
822
835
|
#
|
823
836
|
# Constraints:
|
824
837
|
#
|
@@ -837,7 +850,8 @@ module Aws::DocDB
|
|
837
850
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
838
851
|
#
|
839
852
|
# The default is a 30-minute window selected at random from an 8-hour
|
840
|
-
# 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.
|
841
855
|
#
|
842
856
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
843
857
|
#
|
@@ -853,10 +867,10 @@ module Aws::DocDB
|
|
853
867
|
# The KMS key identifier for an encrypted cluster.
|
854
868
|
#
|
855
869
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
856
|
-
# encryption key. If you are creating a cluster using the same
|
857
|
-
# that owns the KMS encryption key that is used to
|
858
|
-
# cluster, you can use the KMS key alias instead of the
|
859
|
-
# 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.
|
860
874
|
#
|
861
875
|
# If an encryption key is not specified in `KmsKeyId`\:
|
862
876
|
#
|
@@ -865,8 +879,9 @@ module Aws::DocDB
|
|
865
879
|
#
|
866
880
|
# ^
|
867
881
|
#
|
868
|
-
# KMS creates the default encryption key for your
|
869
|
-
#
|
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.
|
870
885
|
#
|
871
886
|
# @option params [String] :pre_signed_url
|
872
887
|
# Not currently supported.
|
@@ -1171,7 +1186,7 @@ module Aws::DocDB
|
|
1171
1186
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
1172
1187
|
#
|
1173
1188
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1174
|
-
# Region.
|
1189
|
+
# Amazon Web Services Region.
|
1175
1190
|
#
|
1176
1191
|
# Example: `us-east-1d`
|
1177
1192
|
#
|
@@ -1182,7 +1197,8 @@ module Aws::DocDB
|
|
1182
1197
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1183
1198
|
#
|
1184
1199
|
# The default is a 30-minute window selected at random from an 8-hour
|
1185
|
-
# block of time for each Region, occurring on a
|
1200
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
1201
|
+
# random day of the week.
|
1186
1202
|
#
|
1187
1203
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
1188
1204
|
#
|
@@ -1210,6 +1226,27 @@ module Aws::DocDB
|
|
1210
1226
|
#
|
1211
1227
|
# Valid values: 0-15
|
1212
1228
|
#
|
1229
|
+
# @option params [Boolean] :enable_performance_insights
|
1230
|
+
# A value that indicates whether to enable Performance Insights for the
|
1231
|
+
# DB Instance. For more information, see [Using Amazon Performance
|
1232
|
+
# Insights][1].
|
1233
|
+
#
|
1234
|
+
#
|
1235
|
+
#
|
1236
|
+
# [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html
|
1237
|
+
#
|
1238
|
+
# @option params [String] :performance_insights_kms_key_id
|
1239
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
1240
|
+
#
|
1241
|
+
# The KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1242
|
+
# name for the KMS key.
|
1243
|
+
#
|
1244
|
+
# If you do not specify a value for PerformanceInsightsKMSKeyId, then
|
1245
|
+
# Amazon DocumentDB uses your default KMS key. There is a default KMS
|
1246
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
1247
|
+
# account has a different default KMS key for each Amazon Web Services
|
1248
|
+
# region.
|
1249
|
+
#
|
1213
1250
|
# @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1214
1251
|
#
|
1215
1252
|
# * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -1231,6 +1268,8 @@ module Aws::DocDB
|
|
1231
1268
|
# ],
|
1232
1269
|
# db_cluster_identifier: "String", # required
|
1233
1270
|
# promotion_tier: 1,
|
1271
|
+
# enable_performance_insights: false,
|
1272
|
+
# performance_insights_kms_key_id: "String",
|
1234
1273
|
# })
|
1235
1274
|
#
|
1236
1275
|
# @example Response structure
|
@@ -1305,7 +1344,8 @@ module Aws::DocDB
|
|
1305
1344
|
end
|
1306
1345
|
|
1307
1346
|
# Creates a new subnet group. subnet groups must contain at least one
|
1308
|
-
# subnet in at least two Availability Zones in the
|
1347
|
+
# subnet in at least two Availability Zones in the Amazon Web Services
|
1348
|
+
# Region.
|
1309
1349
|
#
|
1310
1350
|
# @option params [required, String] :db_subnet_group_name
|
1311
1351
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -1488,11 +1528,12 @@ module Aws::DocDB
|
|
1488
1528
|
end
|
1489
1529
|
|
1490
1530
|
# Creates an Amazon DocumentDB global cluster that can span multiple
|
1491
|
-
# multiple Regions. The global cluster contains one
|
1492
|
-
# read-write capability, and up-to give read-only
|
1493
|
-
# Global clusters uses storage-based fast
|
1494
|
-
# with latencies less than one second, using
|
1495
|
-
# with no impact to your workload’s
|
1531
|
+
# multiple Amazon Web Services Regions. The global cluster contains one
|
1532
|
+
# primary cluster with read-write capability, and up-to give read-only
|
1533
|
+
# secondary clusters. Global clusters uses storage-based fast
|
1534
|
+
# replication across regions with latencies less than one second, using
|
1535
|
+
# dedicated infrastructure with no impact to your workload’s
|
1536
|
+
# performance.
|
1496
1537
|
#
|
1497
1538
|
#
|
1498
1539
|
#
|
@@ -1986,7 +2027,7 @@ module Aws::DocDB
|
|
1986
2027
|
end
|
1987
2028
|
|
1988
2029
|
# Returns a list of certificate authority (CA) certificates provided by
|
1989
|
-
# Amazon DocumentDB for this account.
|
2030
|
+
# Amazon DocumentDB for this Amazon Web Services account.
|
1990
2031
|
#
|
1991
2032
|
# @option params [String] :certificate_identifier
|
1992
2033
|
# The user-supplied certificate identifier. If this parameter is
|
@@ -2221,12 +2262,13 @@ module Aws::DocDB
|
|
2221
2262
|
# Returns a list of cluster snapshot attribute names and values for a
|
2222
2263
|
# manual DB cluster snapshot.
|
2223
2264
|
#
|
2224
|
-
# When you share snapshots with other accounts,
|
2265
|
+
# When you share snapshots with other Amazon Web Services accounts,
|
2225
2266
|
# `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
|
2226
|
-
# and a list of IDs for the accounts that are
|
2227
|
-
# restore the manual cluster snapshot. If `all` is
|
2228
|
-
# of values for the `restore` attribute, then the
|
2229
|
-
# snapshot is public and can be copied or restored by all
|
2267
|
+
# and a list of IDs for the Amazon Web Services accounts that are
|
2268
|
+
# authorized to copy or restore the manual cluster snapshot. If `all` is
|
2269
|
+
# included in the list of values for the `restore` attribute, then the
|
2270
|
+
# manual cluster snapshot is public and can be copied or restored by all
|
2271
|
+
# Amazon Web Services accounts.
|
2230
2272
|
#
|
2231
2273
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
2232
2274
|
# The identifier for the cluster snapshot to describe the attributes
|
@@ -2291,13 +2333,13 @@ module Aws::DocDB
|
|
2291
2333
|
# the following values:
|
2292
2334
|
#
|
2293
2335
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2294
|
-
# has automatically created for your account.
|
2336
|
+
# has automatically created for your Amazon Web Services account.
|
2295
2337
|
#
|
2296
2338
|
# * `manual` - Return all cluster snapshots that you have manually
|
2297
|
-
# created for your account.
|
2339
|
+
# created for your Amazon Web Services account.
|
2298
2340
|
#
|
2299
2341
|
# * `shared` - Return all manual cluster snapshots that have been shared
|
2300
|
-
# to your account.
|
2342
|
+
# to your Amazon Web Services account.
|
2301
2343
|
#
|
2302
2344
|
# * `public` - Return all cluster snapshots that have been marked as
|
2303
2345
|
# public.
|
@@ -2334,13 +2376,14 @@ module Aws::DocDB
|
|
2334
2376
|
#
|
2335
2377
|
# @option params [Boolean] :include_shared
|
2336
2378
|
# Set to `true` to include shared manual cluster snapshots from other
|
2337
|
-
# accounts that this
|
2338
|
-
# restore, and otherwise `false`. The
|
2379
|
+
# Amazon Web Services accounts that this Amazon Web Services account has
|
2380
|
+
# been given permission to copy or restore, and otherwise `false`. The
|
2381
|
+
# default is `false`.
|
2339
2382
|
#
|
2340
2383
|
# @option params [Boolean] :include_public
|
2341
2384
|
# Set to `true` to include manual cluster snapshots that are public and
|
2342
|
-
# can be copied or restored by any account, and
|
2343
|
-
# default is `false`.
|
2385
|
+
# can be copied or restored by any Amazon Web Services account, and
|
2386
|
+
# otherwise `false`. The default is `false`.
|
2344
2387
|
#
|
2345
2388
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2346
2389
|
#
|
@@ -3603,7 +3646,7 @@ module Aws::DocDB
|
|
3603
3646
|
# parameter.
|
3604
3647
|
#
|
3605
3648
|
# The default is a 30-minute window selected at random from an 8-hour
|
3606
|
-
# block of time for each Region.
|
3649
|
+
# block of time for each Amazon Web Services Region.
|
3607
3650
|
#
|
3608
3651
|
# Constraints:
|
3609
3652
|
#
|
@@ -3622,7 +3665,8 @@ module Aws::DocDB
|
|
3622
3665
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
3623
3666
|
#
|
3624
3667
|
# The default is a 30-minute window selected at random from an 8-hour
|
3625
|
-
# block of time for each Region, occurring on a
|
3668
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
3669
|
+
# random day of the week.
|
3626
3670
|
#
|
3627
3671
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
3628
3672
|
#
|
@@ -3790,17 +3834,19 @@ module Aws::DocDB
|
|
3790
3834
|
# Adds an attribute and values to, or removes an attribute and values
|
3791
3835
|
# from, a manual cluster snapshot.
|
3792
3836
|
#
|
3793
|
-
# To share a manual cluster snapshot with other
|
3794
|
-
# `restore` as the `AttributeName`, and use the
|
3795
|
-
# to add a list of IDs of the
|
3796
|
-
#
|
3797
|
-
#
|
3798
|
-
#
|
3799
|
-
#
|
3800
|
-
#
|
3801
|
-
#
|
3802
|
-
#
|
3803
|
-
#
|
3837
|
+
# To share a manual cluster snapshot with other Amazon Web Services
|
3838
|
+
# accounts, specify `restore` as the `AttributeName`, and use the
|
3839
|
+
# `ValuesToAdd` parameter to add a list of IDs of the Amazon Web
|
3840
|
+
# Services accounts that are authorized to restore the manual cluster
|
3841
|
+
# snapshot. Use the value `all` to make the manual cluster snapshot
|
3842
|
+
# public, which means that it can be copied or restored by all Amazon
|
3843
|
+
# Web Services accounts. Do not add the `all` value for any manual
|
3844
|
+
# cluster snapshots that contain private information that you don't
|
3845
|
+
# want available to all Amazon Web Services accounts. If a manual
|
3846
|
+
# cluster snapshot is encrypted, it can be shared, but only by
|
3847
|
+
# specifying a list of authorized Amazon Web Services account IDs for
|
3848
|
+
# the `ValuesToAdd` parameter. You can't use `all` as a value for that
|
3849
|
+
# parameter in this case.
|
3804
3850
|
#
|
3805
3851
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
3806
3852
|
# The identifier for the cluster snapshot to modify the attributes for.
|
@@ -3808,29 +3854,31 @@ module Aws::DocDB
|
|
3808
3854
|
# @option params [required, String] :attribute_name
|
3809
3855
|
# The name of the cluster snapshot attribute to modify.
|
3810
3856
|
#
|
3811
|
-
# To manage authorization for other accounts to copy
|
3812
|
-
# cluster snapshot, set this value to `restore`.
|
3857
|
+
# To manage authorization for other Amazon Web Services accounts to copy
|
3858
|
+
# or restore a manual cluster snapshot, set this value to `restore`.
|
3813
3859
|
#
|
3814
3860
|
# @option params [Array<String>] :values_to_add
|
3815
3861
|
# A list of cluster snapshot attributes to add to the attribute
|
3816
3862
|
# specified by `AttributeName`.
|
3817
3863
|
#
|
3818
|
-
# To authorize other accounts to copy or restore a
|
3819
|
-
# snapshot, set this list to include one or more
|
3820
|
-
#
|
3821
|
-
#
|
3822
|
-
#
|
3823
|
-
# to all
|
3864
|
+
# To authorize other Amazon Web Services accounts to copy or restore a
|
3865
|
+
# manual cluster snapshot, set this list to include one or more Amazon
|
3866
|
+
# Web Services account IDs. To make the manual cluster snapshot
|
3867
|
+
# restorable by any Amazon Web Services account, set it to `all`. Do not
|
3868
|
+
# add the `all` value for any manual cluster snapshots that contain
|
3869
|
+
# private information that you don't want to be available to all Amazon
|
3870
|
+
# Web Services accounts.
|
3824
3871
|
#
|
3825
3872
|
# @option params [Array<String>] :values_to_remove
|
3826
3873
|
# A list of cluster snapshot attributes to remove from the attribute
|
3827
3874
|
# specified by `AttributeName`.
|
3828
3875
|
#
|
3829
|
-
# To remove authorization for other accounts to copy
|
3830
|
-
# cluster snapshot, set this list to include one or
|
3831
|
-
# identifiers. To remove authorization
|
3832
|
-
#
|
3833
|
-
#
|
3876
|
+
# To remove authorization for other Amazon Web Services accounts to copy
|
3877
|
+
# or restore a manual cluster snapshot, set this list to include one or
|
3878
|
+
# more Amazon Web Services account identifiers. To remove authorization
|
3879
|
+
# for any Amazon Web Services account to copy or restore the cluster
|
3880
|
+
# snapshot, set it to `all` . If you specify `all`, an Amazon Web
|
3881
|
+
# Services account whose account ID is explicitly added to the `restore`
|
3834
3882
|
# attribute can still copy or restore a manual cluster snapshot.
|
3835
3883
|
#
|
3836
3884
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3878,7 +3926,8 @@ module Aws::DocDB
|
|
3878
3926
|
#
|
3879
3927
|
# @option params [String] :db_instance_class
|
3880
3928
|
# The new compute and memory capacity of the instance; for example,
|
3881
|
-
# `db.r5.large`. Not all instance classes are available in all
|
3929
|
+
# `db.r5.large`. Not all instance classes are available in all Amazon
|
3930
|
+
# Web Services Regions.
|
3882
3931
|
#
|
3883
3932
|
# If you modify the instance class, an outage occurs during the change.
|
3884
3933
|
# The change is applied during the next maintenance window, unless
|
@@ -3951,6 +4000,27 @@ module Aws::DocDB
|
|
3951
4000
|
#
|
3952
4001
|
# Valid values: 0-15
|
3953
4002
|
#
|
4003
|
+
# @option params [Boolean] :enable_performance_insights
|
4004
|
+
# A value that indicates whether to enable Performance Insights for the
|
4005
|
+
# DB Instance. For more information, see [Using Amazon Performance
|
4006
|
+
# Insights][1].
|
4007
|
+
#
|
4008
|
+
#
|
4009
|
+
#
|
4010
|
+
# [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html
|
4011
|
+
#
|
4012
|
+
# @option params [String] :performance_insights_kms_key_id
|
4013
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
4014
|
+
#
|
4015
|
+
# The KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
4016
|
+
# name for the KMS key.
|
4017
|
+
#
|
4018
|
+
# If you do not specify a value for PerformanceInsightsKMSKeyId, then
|
4019
|
+
# Amazon DocumentDB uses your default KMS key. There is a default KMS
|
4020
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
4021
|
+
# account has a different default KMS key for each Amazon Web Services
|
4022
|
+
# region.
|
4023
|
+
#
|
3954
4024
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3955
4025
|
#
|
3956
4026
|
# * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -3966,6 +4036,8 @@ module Aws::DocDB
|
|
3966
4036
|
# new_db_instance_identifier: "String",
|
3967
4037
|
# ca_certificate_identifier: "String",
|
3968
4038
|
# promotion_tier: 1,
|
4039
|
+
# enable_performance_insights: false,
|
4040
|
+
# performance_insights_kms_key_id: "String",
|
3969
4041
|
# })
|
3970
4042
|
#
|
3971
4043
|
# @example Response structure
|
@@ -4040,7 +4112,8 @@ module Aws::DocDB
|
|
4040
4112
|
end
|
4041
4113
|
|
4042
4114
|
# Modifies an existing subnet group. subnet groups must contain at least
|
4043
|
-
# one subnet in at least two Availability Zones in the
|
4115
|
+
# one subnet in at least two Availability Zones in the Amazon Web
|
4116
|
+
# Services Region.
|
4044
4117
|
#
|
4045
4118
|
# @option params [required, String] :db_subnet_group_name
|
4046
4119
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -4602,10 +4675,10 @@ module Aws::DocDB
|
|
4602
4675
|
# a DB snapshot or cluster snapshot.
|
4603
4676
|
#
|
4604
4677
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4605
|
-
# encryption key. If you are restoring a cluster with the same
|
4606
|
-
# that owns the KMS encryption key used to encrypt
|
4607
|
-
# you can use the KMS key alias instead of the ARN
|
4608
|
-
# encryption key.
|
4678
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
4679
|
+
# Web Services account that owns the KMS encryption key used to encrypt
|
4680
|
+
# the new cluster, then you can use the KMS key alias instead of the ARN
|
4681
|
+
# for the KMS encryption key.
|
4609
4682
|
#
|
4610
4683
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4611
4684
|
# following occurs:
|
@@ -4789,10 +4862,10 @@ module Aws::DocDB
|
|
4789
4862
|
# an encrypted cluster.
|
4790
4863
|
#
|
4791
4864
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4792
|
-
# encryption key. If you are restoring a cluster with the same
|
4793
|
-
# that owns the KMS encryption key used to encrypt
|
4794
|
-
# you can use the KMS key alias instead of the ARN
|
4795
|
-
# encryption key.
|
4865
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
4866
|
+
# Web Services account that owns the KMS encryption key used to encrypt
|
4867
|
+
# the new cluster, then you can use the KMS key alias instead of the ARN
|
4868
|
+
# for the KMS encryption key.
|
4796
4869
|
#
|
4797
4870
|
# You can restore to a new cluster and encrypt the new cluster with an
|
4798
4871
|
# KMS key that is different from the KMS key used to encrypt the source
|
@@ -5065,7 +5138,7 @@ module Aws::DocDB
|
|
5065
5138
|
params: params,
|
5066
5139
|
config: config)
|
5067
5140
|
context[:gem_name] = 'aws-sdk-docdb'
|
5068
|
-
context[:gem_version] = '1.
|
5141
|
+
context[:gem_version] = '1.42.0'
|
5069
5142
|
Seahorse::Client::Request.new(handlers, context)
|
5070
5143
|
end
|
5071
5144
|
|
@@ -373,6 +373,8 @@ module Aws::DocDB
|
|
373
373
|
CreateDBInstanceMessage.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
374
374
|
CreateDBInstanceMessage.add_member(:db_cluster_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBClusterIdentifier"))
|
375
375
|
CreateDBInstanceMessage.add_member(:promotion_tier, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "PromotionTier"))
|
376
|
+
CreateDBInstanceMessage.add_member(:enable_performance_insights, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnablePerformanceInsights"))
|
377
|
+
CreateDBInstanceMessage.add_member(:performance_insights_kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "PerformanceInsightsKMSKeyId"))
|
376
378
|
CreateDBInstanceMessage.struct_class = Types::CreateDBInstanceMessage
|
377
379
|
|
378
380
|
CreateDBInstanceResult.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
@@ -968,6 +970,8 @@ module Aws::DocDB
|
|
968
970
|
ModifyDBInstanceMessage.add_member(:new_db_instance_identifier, Shapes::ShapeRef.new(shape: String, location_name: "NewDBInstanceIdentifier"))
|
969
971
|
ModifyDBInstanceMessage.add_member(:ca_certificate_identifier, Shapes::ShapeRef.new(shape: String, location_name: "CACertificateIdentifier"))
|
970
972
|
ModifyDBInstanceMessage.add_member(:promotion_tier, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "PromotionTier"))
|
973
|
+
ModifyDBInstanceMessage.add_member(:enable_performance_insights, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "EnablePerformanceInsights"))
|
974
|
+
ModifyDBInstanceMessage.add_member(:performance_insights_kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "PerformanceInsightsKMSKeyId"))
|
971
975
|
ModifyDBInstanceMessage.struct_class = Types::ModifyDBInstanceMessage
|
972
976
|
|
973
977
|
ModifyDBInstanceResult.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
data/lib/aws-sdk-docdb/types.rb
CHANGED
@@ -179,7 +179,8 @@ module Aws::DocDB
|
|
179
179
|
include Aws::Structure
|
180
180
|
end
|
181
181
|
|
182
|
-
# A certificate authority (CA) certificate for an
|
182
|
+
# A certificate authority (CA) certificate for an Amazon Web Services
|
183
|
+
# account.
|
183
184
|
#
|
184
185
|
# @!attribute [rw] certificate_identifier
|
185
186
|
# The unique key that identifies a certificate.
|
@@ -229,7 +230,7 @@ module Aws::DocDB
|
|
229
230
|
end
|
230
231
|
|
231
232
|
# @!attribute [rw] certificates
|
232
|
-
# A list of certificates for this account.
|
233
|
+
# A list of certificates for this Amazon Web Services account.
|
233
234
|
# @return [Array<Types::Certificate>]
|
234
235
|
#
|
235
236
|
# @!attribute [rw] marker
|
@@ -312,12 +313,14 @@ module Aws::DocDB
|
|
312
313
|
#
|
313
314
|
# * Must specify a valid cluster parameter group.
|
314
315
|
#
|
315
|
-
# * If the source cluster parameter group is in the same
|
316
|
-
# copy, specify a valid parameter group
|
317
|
-
# `my-db-cluster-param-group`, or a valid
|
316
|
+
# * If the source cluster parameter group is in the same Amazon Web
|
317
|
+
# Services Region as the copy, specify a valid parameter group
|
318
|
+
# identifier; for example, `my-db-cluster-param-group`, or a valid
|
319
|
+
# ARN.
|
318
320
|
#
|
319
|
-
# * If the source parameter group is in a different
|
320
|
-
# copy, specify a valid cluster parameter
|
321
|
+
# * If the source parameter group is in a different Amazon Web
|
322
|
+
# Services Region than the copy, specify a valid cluster parameter
|
323
|
+
# group ARN; for example,
|
321
324
|
# `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
|
322
325
|
# @return [String]
|
323
326
|
#
|
@@ -396,11 +399,11 @@ module Aws::DocDB
|
|
396
399
|
#
|
397
400
|
# * Must specify a valid system snapshot in the *available* state.
|
398
401
|
#
|
399
|
-
# * If the source snapshot is in the same
|
400
|
-
# a valid snapshot identifier.
|
402
|
+
# * If the source snapshot is in the same Amazon Web Services Region
|
403
|
+
# as the copy, specify a valid snapshot identifier.
|
401
404
|
#
|
402
|
-
# * If the source snapshot is in a different
|
403
|
-
# specify a valid cluster snapshot ARN.
|
405
|
+
# * If the source snapshot is in a different Amazon Web Services
|
406
|
+
# Region than the copy, specify a valid cluster snapshot ARN.
|
404
407
|
#
|
405
408
|
# Example: `my-cluster-snapshot1`
|
406
409
|
# @return [String]
|
@@ -425,20 +428,22 @@ module Aws::DocDB
|
|
425
428
|
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
426
429
|
# alias for the KMS encryption key.
|
427
430
|
#
|
428
|
-
# If you copy an encrypted cluster snapshot from your
|
429
|
-
# specify a value for `KmsKeyId` to encrypt
|
430
|
-
# encryption key. If you don't specify a
|
431
|
-
# the copy of the cluster snapshot is
|
432
|
-
# as the source cluster snapshot.
|
431
|
+
# If you copy an encrypted cluster snapshot from your Amazon Web
|
432
|
+
# Services account, you can specify a value for `KmsKeyId` to encrypt
|
433
|
+
# the copy with a new KMS encryption key. If you don't specify a
|
434
|
+
# value for `KmsKeyId`, then the copy of the cluster snapshot is
|
435
|
+
# encrypted with the same KMS key as the source cluster snapshot.
|
433
436
|
#
|
434
437
|
# If you copy an encrypted cluster snapshot that is shared from
|
435
|
-
# another account, then you must specify a value
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
438
|
+
# another Amazon Web Services account, then you must specify a value
|
439
|
+
# for `KmsKeyId`.
|
440
|
+
#
|
441
|
+
# To copy an encrypted cluster snapshot to another Amazon Web Services
|
442
|
+
# Region, set `KmsKeyId` to the KMS key ID that you want to use to
|
443
|
+
# encrypt the copy of the cluster snapshot in the destination Region.
|
444
|
+
# KMS encryption keys are specific to the Amazon Web Services Region
|
445
|
+
# that they are created in, and you can't use encryption keys from
|
446
|
+
# one Amazon Web Services Region in another Amazon Web Services
|
442
447
|
# Region.
|
443
448
|
#
|
444
449
|
# If you copy an unencrypted cluster snapshot and specify a value for
|
@@ -447,31 +452,34 @@ module Aws::DocDB
|
|
447
452
|
#
|
448
453
|
# @!attribute [rw] pre_signed_url
|
449
454
|
# The URL that contains a Signature Version 4 signed request for
|
450
|
-
# the`CopyDBClusterSnapshot` API action in the
|
451
|
-
# the source cluster snapshot to copy. You must
|
452
|
-
# parameter when copying a cluster snapshot
|
455
|
+
# the`CopyDBClusterSnapshot` API action in the Amazon Web Services
|
456
|
+
# Region that contains the source cluster snapshot to copy. You must
|
457
|
+
# use the `PreSignedUrl` parameter when copying a cluster snapshot
|
458
|
+
# from another Amazon Web Services Region.
|
453
459
|
#
|
454
460
|
# If you are using an Amazon Web Services SDK tool or the CLI, you can
|
455
461
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
456
462
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
457
463
|
# autogenerates a pre-signed URL that is a valid request for the
|
458
|
-
# operation that can be executed in the source
|
464
|
+
# operation that can be executed in the source Amazon Web Services
|
465
|
+
# Region.
|
459
466
|
#
|
460
467
|
# The presigned URL must be a valid request for the
|
461
468
|
# `CopyDBClusterSnapshot` API action that can be executed in the
|
462
|
-
# source Region that contains the cluster snapshot
|
463
|
-
# presigned URL request must contain the following
|
469
|
+
# source Amazon Web Services Region that contains the cluster snapshot
|
470
|
+
# to be copied. The presigned URL request must contain the following
|
471
|
+
# parameter values:
|
464
472
|
#
|
465
473
|
# * `SourceRegion` - The ID of the region that contains the snapshot
|
466
474
|
# to be copied.
|
467
475
|
#
|
468
476
|
# * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
|
469
477
|
# encrypted cluster snapshot to be copied. This identifier must be
|
470
|
-
# in the Amazon Resource Name (ARN) format for the source
|
471
|
-
# For example, if you are copying an encrypted
|
472
|
-
# the us-east-1 Region,
|
473
|
-
# `SourceDBClusterSnapshotIdentifier` looks something like
|
474
|
-
# following:
|
478
|
+
# in the Amazon Resource Name (ARN) format for the source Amazon Web
|
479
|
+
# Services Region. For example, if you are copying an encrypted
|
480
|
+
# cluster snapshot from the us-east-1 Amazon Web Services Region,
|
481
|
+
# then your `SourceDBClusterSnapshotIdentifier` looks something like
|
482
|
+
# the following:
|
475
483
|
# `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
|
476
484
|
#
|
477
485
|
# * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
|
@@ -649,7 +657,7 @@ module Aws::DocDB
|
|
649
657
|
# parameter.
|
650
658
|
#
|
651
659
|
# The default is a 30-minute window selected at random from an 8-hour
|
652
|
-
# block of time for each Region.
|
660
|
+
# block of time for each Amazon Web Services Region.
|
653
661
|
#
|
654
662
|
# Constraints:
|
655
663
|
#
|
@@ -669,8 +677,8 @@ module Aws::DocDB
|
|
669
677
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
670
678
|
#
|
671
679
|
# The default is a 30-minute window selected at random from an 8-hour
|
672
|
-
# block of time for each Region, occurring on a
|
673
|
-
# week.
|
680
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
681
|
+
# random day of the week.
|
674
682
|
#
|
675
683
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
676
684
|
#
|
@@ -689,10 +697,10 @@ module Aws::DocDB
|
|
689
697
|
# The KMS key identifier for an encrypted cluster.
|
690
698
|
#
|
691
699
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
692
|
-
# encryption key. If you are creating a cluster using the same
|
693
|
-
# that owns the KMS encryption key that is used
|
694
|
-
# cluster, you can use the KMS key alias instead of
|
695
|
-
# KMS encryption key.
|
700
|
+
# encryption key. If you are creating a cluster using the same Amazon
|
701
|
+
# Web Services account that owns the KMS encryption key that is used
|
702
|
+
# to encrypt the new cluster, you can use the KMS key alias instead of
|
703
|
+
# the ARN for the KMS encryption key.
|
696
704
|
#
|
697
705
|
# If an encryption key is not specified in `KmsKeyId`\:
|
698
706
|
#
|
@@ -701,8 +709,9 @@ module Aws::DocDB
|
|
701
709
|
#
|
702
710
|
# ^
|
703
711
|
#
|
704
|
-
# KMS creates the default encryption key for your
|
705
|
-
# account
|
712
|
+
# KMS creates the default encryption key for your Amazon Web Services
|
713
|
+
# account. Your Amazon Web Services account has a different default
|
714
|
+
# encryption key for each Amazon Web Services Regions.
|
706
715
|
# @return [String]
|
707
716
|
#
|
708
717
|
# @!attribute [rw] pre_signed_url
|
@@ -934,6 +943,8 @@ module Aws::DocDB
|
|
934
943
|
# ],
|
935
944
|
# db_cluster_identifier: "String", # required
|
936
945
|
# promotion_tier: 1,
|
946
|
+
# enable_performance_insights: false,
|
947
|
+
# performance_insights_kms_key_id: "String",
|
937
948
|
# }
|
938
949
|
#
|
939
950
|
# @!attribute [rw] db_instance_identifier
|
@@ -966,7 +977,7 @@ module Aws::DocDB
|
|
966
977
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
967
978
|
#
|
968
979
|
# Default: A random, system-chosen Availability Zone in the
|
969
|
-
# endpoint's Region.
|
980
|
+
# endpoint's Amazon Web Services Region.
|
970
981
|
#
|
971
982
|
# Example: `us-east-1d`
|
972
983
|
# @return [String]
|
@@ -978,8 +989,8 @@ module Aws::DocDB
|
|
978
989
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
979
990
|
#
|
980
991
|
# The default is a 30-minute window selected at random from an 8-hour
|
981
|
-
# block of time for each Region, occurring on a
|
982
|
-
# week.
|
992
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
993
|
+
# random day of the week.
|
983
994
|
#
|
984
995
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
985
996
|
#
|
@@ -1013,6 +1024,29 @@ module Aws::DocDB
|
|
1013
1024
|
# Valid values: 0-15
|
1014
1025
|
# @return [Integer]
|
1015
1026
|
#
|
1027
|
+
# @!attribute [rw] enable_performance_insights
|
1028
|
+
# A value that indicates whether to enable Performance Insights for
|
1029
|
+
# the DB Instance. For more information, see [Using Amazon Performance
|
1030
|
+
# Insights][1].
|
1031
|
+
#
|
1032
|
+
#
|
1033
|
+
#
|
1034
|
+
# [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html
|
1035
|
+
# @return [Boolean]
|
1036
|
+
#
|
1037
|
+
# @!attribute [rw] performance_insights_kms_key_id
|
1038
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
1039
|
+
#
|
1040
|
+
# The KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1041
|
+
# name for the KMS key.
|
1042
|
+
#
|
1043
|
+
# If you do not specify a value for PerformanceInsightsKMSKeyId, then
|
1044
|
+
# Amazon DocumentDB uses your default KMS key. There is a default KMS
|
1045
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
1046
|
+
# account has a different default KMS key for each Amazon Web Services
|
1047
|
+
# region.
|
1048
|
+
# @return [String]
|
1049
|
+
#
|
1016
1050
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstanceMessage AWS API Documentation
|
1017
1051
|
#
|
1018
1052
|
class CreateDBInstanceMessage < Struct.new(
|
@@ -1024,7 +1058,9 @@ module Aws::DocDB
|
|
1024
1058
|
:auto_minor_version_upgrade,
|
1025
1059
|
:tags,
|
1026
1060
|
:db_cluster_identifier,
|
1027
|
-
:promotion_tier
|
1061
|
+
:promotion_tier,
|
1062
|
+
:enable_performance_insights,
|
1063
|
+
:performance_insights_kms_key_id)
|
1028
1064
|
SENSITIVE = []
|
1029
1065
|
include Aws::Structure
|
1030
1066
|
end
|
@@ -1416,9 +1452,9 @@ module Aws::DocDB
|
|
1416
1452
|
# @return [String]
|
1417
1453
|
#
|
1418
1454
|
# @!attribute [rw] db_cluster_resource_id
|
1419
|
-
# The Region-unique, immutable identifier for the
|
1420
|
-
# identifier is found in CloudTrail log entries whenever
|
1421
|
-
# for the cluster is accessed.
|
1455
|
+
# The Amazon Web Services Region-unique, immutable identifier for the
|
1456
|
+
# cluster. This identifier is found in CloudTrail log entries whenever
|
1457
|
+
# the KMS key for the cluster is accessed.
|
1422
1458
|
# @return [String]
|
1423
1459
|
#
|
1424
1460
|
# @!attribute [rw] db_cluster_arn
|
@@ -1810,24 +1846,26 @@ module Aws::DocDB
|
|
1810
1846
|
|
1811
1847
|
# Contains the name and values of a manual cluster snapshot attribute.
|
1812
1848
|
#
|
1813
|
-
# Manual cluster snapshot attributes are used to authorize other
|
1814
|
-
# accounts to restore a manual cluster snapshot.
|
1849
|
+
# Manual cluster snapshot attributes are used to authorize other Amazon
|
1850
|
+
# Web Services accounts to restore a manual cluster snapshot.
|
1815
1851
|
#
|
1816
1852
|
# @!attribute [rw] attribute_name
|
1817
1853
|
# The name of the manual cluster snapshot attribute.
|
1818
1854
|
#
|
1819
|
-
# The attribute named `restore` refers to the list of
|
1820
|
-
# have permission to copy or restore the manual
|
1855
|
+
# The attribute named `restore` refers to the list of Amazon Web
|
1856
|
+
# Services accounts that have permission to copy or restore the manual
|
1857
|
+
# cluster snapshot.
|
1821
1858
|
# @return [String]
|
1822
1859
|
#
|
1823
1860
|
# @!attribute [rw] attribute_values
|
1824
1861
|
# The values for the manual cluster snapshot attribute.
|
1825
1862
|
#
|
1826
1863
|
# If the `AttributeName` field is set to `restore`, then this element
|
1827
|
-
# returns a list of IDs of the accounts that are
|
1828
|
-
# restore the manual cluster snapshot. If a
|
1829
|
-
# list, then the manual cluster snapshot is
|
1830
|
-
# any account to copy or
|
1864
|
+
# returns a list of IDs of the Amazon Web Services accounts that are
|
1865
|
+
# authorized to copy or restore the manual cluster snapshot. If a
|
1866
|
+
# value of `all` is in the list, then the manual cluster snapshot is
|
1867
|
+
# public and available for any Amazon Web Services account to copy or
|
1868
|
+
# restore.
|
1831
1869
|
# @return [Array<String>]
|
1832
1870
|
#
|
1833
1871
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttribute AWS API Documentation
|
@@ -2067,9 +2105,9 @@ module Aws::DocDB
|
|
2067
2105
|
# @return [String]
|
2068
2106
|
#
|
2069
2107
|
# @!attribute [rw] dbi_resource_id
|
2070
|
-
# The Region-unique, immutable identifier for the
|
2071
|
-
# identifier is found in CloudTrail log entries
|
2072
|
-
# for the instance is accessed.
|
2108
|
+
# The Amazon Web Services Region-unique, immutable identifier for the
|
2109
|
+
# instance. This identifier is found in CloudTrail log entries
|
2110
|
+
# whenever the KMS key for the instance is accessed.
|
2073
2111
|
# @return [String]
|
2074
2112
|
#
|
2075
2113
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -2888,13 +2926,13 @@ module Aws::DocDB
|
|
2888
2926
|
# the following values:
|
2889
2927
|
#
|
2890
2928
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2891
|
-
# has automatically created for your account.
|
2929
|
+
# has automatically created for your Amazon Web Services account.
|
2892
2930
|
#
|
2893
2931
|
# * `manual` - Return all cluster snapshots that you have manually
|
2894
|
-
# created for your account.
|
2932
|
+
# created for your Amazon Web Services account.
|
2895
2933
|
#
|
2896
2934
|
# * `shared` - Return all manual cluster snapshots that have been
|
2897
|
-
# shared to your account.
|
2935
|
+
# shared to your Amazon Web Services account.
|
2898
2936
|
#
|
2899
2937
|
# * `public` - Return all cluster snapshots that have been marked as
|
2900
2938
|
# public.
|
@@ -2935,14 +2973,15 @@ module Aws::DocDB
|
|
2935
2973
|
#
|
2936
2974
|
# @!attribute [rw] include_shared
|
2937
2975
|
# Set to `true` to include shared manual cluster snapshots from other
|
2938
|
-
# accounts that this
|
2939
|
-
# restore, and otherwise `false`.
|
2976
|
+
# Amazon Web Services accounts that this Amazon Web Services account
|
2977
|
+
# has been given permission to copy or restore, and otherwise `false`.
|
2978
|
+
# The default is `false`.
|
2940
2979
|
# @return [Boolean]
|
2941
2980
|
#
|
2942
2981
|
# @!attribute [rw] include_public
|
2943
2982
|
# Set to `true` to include manual cluster snapshots that are public
|
2944
|
-
# and can be copied or restored by any
|
2945
|
-
# The default is `false`.
|
2983
|
+
# and can be copied or restored by any Amazon Web Services account,
|
2984
|
+
# and otherwise `false`. The default is `false`.
|
2946
2985
|
# @return [Boolean]
|
2947
2986
|
#
|
2948
2987
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotsMessage AWS API Documentation
|
@@ -4058,10 +4097,10 @@ module Aws::DocDB
|
|
4058
4097
|
# @return [String]
|
4059
4098
|
#
|
4060
4099
|
# @!attribute [rw] global_cluster_resource_id
|
4061
|
-
# The Region-unique, immutable identifier for the
|
4062
|
-
# cluster. This identifier is found in AWS CloudTrail
|
4063
|
-
# whenever the AWS KMS customer master key (CMK) for the
|
4064
|
-
# accessed.
|
4100
|
+
# The Amazon Web Services Region-unique, immutable identifier for the
|
4101
|
+
# global database cluster. This identifier is found in AWS CloudTrail
|
4102
|
+
# log entries whenever the AWS KMS customer master key (CMK) for the
|
4103
|
+
# cluster is accessed.
|
4065
4104
|
# @return [String]
|
4066
4105
|
#
|
4067
4106
|
# @!attribute [rw] global_cluster_arn
|
@@ -4441,7 +4480,7 @@ module Aws::DocDB
|
|
4441
4480
|
# parameter.
|
4442
4481
|
#
|
4443
4482
|
# The default is a 30-minute window selected at random from an 8-hour
|
4444
|
-
# block of time for each Region.
|
4483
|
+
# block of time for each Amazon Web Services Region.
|
4445
4484
|
#
|
4446
4485
|
# Constraints:
|
4447
4486
|
#
|
@@ -4461,8 +4500,8 @@ module Aws::DocDB
|
|
4461
4500
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
4462
4501
|
#
|
4463
4502
|
# The default is a 30-minute window selected at random from an 8-hour
|
4464
|
-
# block of time for each Region, occurring on a
|
4465
|
-
# week.
|
4503
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
4504
|
+
# random day of the week.
|
4466
4505
|
#
|
4467
4506
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
4468
4507
|
#
|
@@ -4582,32 +4621,35 @@ module Aws::DocDB
|
|
4582
4621
|
# @!attribute [rw] attribute_name
|
4583
4622
|
# The name of the cluster snapshot attribute to modify.
|
4584
4623
|
#
|
4585
|
-
# To manage authorization for other
|
4586
|
-
# manual cluster snapshot, set this value to
|
4624
|
+
# To manage authorization for other Amazon Web Services accounts to
|
4625
|
+
# copy or restore a manual cluster snapshot, set this value to
|
4626
|
+
# `restore`.
|
4587
4627
|
# @return [String]
|
4588
4628
|
#
|
4589
4629
|
# @!attribute [rw] values_to_add
|
4590
4630
|
# A list of cluster snapshot attributes to add to the attribute
|
4591
4631
|
# specified by `AttributeName`.
|
4592
4632
|
#
|
4593
|
-
# To authorize other accounts to copy or restore a
|
4594
|
-
# snapshot, set this list to include one or more
|
4595
|
-
#
|
4596
|
-
#
|
4597
|
-
#
|
4598
|
-
#
|
4633
|
+
# To authorize other Amazon Web Services accounts to copy or restore a
|
4634
|
+
# manual cluster snapshot, set this list to include one or more Amazon
|
4635
|
+
# Web Services account IDs. To make the manual cluster snapshot
|
4636
|
+
# restorable by any Amazon Web Services account, set it to `all`. Do
|
4637
|
+
# not add the `all` value for any manual cluster snapshots that
|
4638
|
+
# contain private information that you don't want to be available to
|
4639
|
+
# all Amazon Web Services accounts.
|
4599
4640
|
# @return [Array<String>]
|
4600
4641
|
#
|
4601
4642
|
# @!attribute [rw] values_to_remove
|
4602
4643
|
# A list of cluster snapshot attributes to remove from the attribute
|
4603
4644
|
# specified by `AttributeName`.
|
4604
4645
|
#
|
4605
|
-
# To remove authorization for other
|
4606
|
-
# manual cluster snapshot, set this list to include
|
4607
|
-
#
|
4608
|
-
#
|
4609
|
-
#
|
4610
|
-
#
|
4646
|
+
# To remove authorization for other Amazon Web Services accounts to
|
4647
|
+
# copy or restore a manual cluster snapshot, set this list to include
|
4648
|
+
# one or more Amazon Web Services account identifiers. To remove
|
4649
|
+
# authorization for any Amazon Web Services account to copy or restore
|
4650
|
+
# the cluster snapshot, set it to `all` . If you specify `all`, an
|
4651
|
+
# Amazon Web Services account whose account ID is explicitly added to
|
4652
|
+
# the `restore` attribute can still copy or restore a manual cluster
|
4611
4653
|
# snapshot.
|
4612
4654
|
# @return [Array<String>]
|
4613
4655
|
#
|
@@ -4649,6 +4691,8 @@ module Aws::DocDB
|
|
4649
4691
|
# new_db_instance_identifier: "String",
|
4650
4692
|
# ca_certificate_identifier: "String",
|
4651
4693
|
# promotion_tier: 1,
|
4694
|
+
# enable_performance_insights: false,
|
4695
|
+
# performance_insights_kms_key_id: "String",
|
4652
4696
|
# }
|
4653
4697
|
#
|
4654
4698
|
# @!attribute [rw] db_instance_identifier
|
@@ -4663,8 +4707,8 @@ module Aws::DocDB
|
|
4663
4707
|
#
|
4664
4708
|
# @!attribute [rw] db_instance_class
|
4665
4709
|
# The new compute and memory capacity of the instance; for example,
|
4666
|
-
# `db.r5.large`. Not all instance classes are available in all
|
4667
|
-
# Regions.
|
4710
|
+
# `db.r5.large`. Not all instance classes are available in all Amazon
|
4711
|
+
# Web Services Regions.
|
4668
4712
|
#
|
4669
4713
|
# If you modify the instance class, an outage occurs during the
|
4670
4714
|
# change. The change is applied during the next maintenance window,
|
@@ -4746,6 +4790,29 @@ module Aws::DocDB
|
|
4746
4790
|
# Valid values: 0-15
|
4747
4791
|
# @return [Integer]
|
4748
4792
|
#
|
4793
|
+
# @!attribute [rw] enable_performance_insights
|
4794
|
+
# A value that indicates whether to enable Performance Insights for
|
4795
|
+
# the DB Instance. For more information, see [Using Amazon Performance
|
4796
|
+
# Insights][1].
|
4797
|
+
#
|
4798
|
+
#
|
4799
|
+
#
|
4800
|
+
# [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html
|
4801
|
+
# @return [Boolean]
|
4802
|
+
#
|
4803
|
+
# @!attribute [rw] performance_insights_kms_key_id
|
4804
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
4805
|
+
#
|
4806
|
+
# The KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
4807
|
+
# name for the KMS key.
|
4808
|
+
#
|
4809
|
+
# If you do not specify a value for PerformanceInsightsKMSKeyId, then
|
4810
|
+
# Amazon DocumentDB uses your default KMS key. There is a default KMS
|
4811
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
4812
|
+
# account has a different default KMS key for each Amazon Web Services
|
4813
|
+
# region.
|
4814
|
+
# @return [String]
|
4815
|
+
#
|
4749
4816
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
|
4750
4817
|
#
|
4751
4818
|
class ModifyDBInstanceMessage < Struct.new(
|
@@ -4756,7 +4823,9 @@ module Aws::DocDB
|
|
4756
4823
|
:auto_minor_version_upgrade,
|
4757
4824
|
:new_db_instance_identifier,
|
4758
4825
|
:ca_certificate_identifier,
|
4759
|
-
:promotion_tier
|
4826
|
+
:promotion_tier,
|
4827
|
+
:enable_performance_insights,
|
4828
|
+
:performance_insights_kms_key_id)
|
4760
4829
|
SENSITIVE = []
|
4761
4830
|
include Aws::Structure
|
4762
4831
|
end
|
@@ -5615,10 +5684,10 @@ module Aws::DocDB
|
|
5615
5684
|
# from a DB snapshot or cluster snapshot.
|
5616
5685
|
#
|
5617
5686
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
5618
|
-
# encryption key. If you are restoring a cluster with the same
|
5619
|
-
# that owns the KMS encryption key used to
|
5620
|
-
# then you can use the KMS key alias instead
|
5621
|
-
# encryption key.
|
5687
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
5688
|
+
# Web Services account that owns the KMS encryption key used to
|
5689
|
+
# encrypt the new cluster, then you can use the KMS key alias instead
|
5690
|
+
# of the ARN for the KMS encryption key.
|
5622
5691
|
#
|
5623
5692
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
5624
5693
|
# following occurs:
|
@@ -5782,10 +5851,10 @@ module Aws::DocDB
|
|
5782
5851
|
# from an encrypted cluster.
|
5783
5852
|
#
|
5784
5853
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
5785
|
-
# encryption key. If you are restoring a cluster with the same
|
5786
|
-
# that owns the KMS encryption key used to
|
5787
|
-
# then you can use the KMS key alias instead
|
5788
|
-
# encryption key.
|
5854
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
5855
|
+
# Web Services account that owns the KMS encryption key used to
|
5856
|
+
# encrypt the new cluster, then you can use the KMS key alias instead
|
5857
|
+
# of the ARN for the KMS encryption key.
|
5789
5858
|
#
|
5790
5859
|
# You can restore to a new cluster and encrypt the new cluster with an
|
5791
5860
|
# KMS key that is different from the KMS key used to encrypt the
|
data/lib/aws-sdk-docdb.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-docdb
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.42.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-04-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.127.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.127.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|