aws-sdk-docdb 1.41.0 → 1.42.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-docdb/client.rb +167 -98
- 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 +2 -2
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
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.42.0
|
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.
|
@@ -1175,7 +1186,7 @@ module Aws::DocDB
|
|
1175
1186
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
1176
1187
|
#
|
1177
1188
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1178
|
-
# Region.
|
1189
|
+
# Amazon Web Services Region.
|
1179
1190
|
#
|
1180
1191
|
# Example: `us-east-1d`
|
1181
1192
|
#
|
@@ -1186,7 +1197,8 @@ module Aws::DocDB
|
|
1186
1197
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1187
1198
|
#
|
1188
1199
|
# The default is a 30-minute window selected at random from an 8-hour
|
1189
|
-
# 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.
|
1190
1202
|
#
|
1191
1203
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
1192
1204
|
#
|
@@ -1214,6 +1226,27 @@ module Aws::DocDB
|
|
1214
1226
|
#
|
1215
1227
|
# Valid values: 0-15
|
1216
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
|
+
#
|
1217
1250
|
# @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1218
1251
|
#
|
1219
1252
|
# * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -1235,6 +1268,8 @@ module Aws::DocDB
|
|
1235
1268
|
# ],
|
1236
1269
|
# db_cluster_identifier: "String", # required
|
1237
1270
|
# promotion_tier: 1,
|
1271
|
+
# enable_performance_insights: false,
|
1272
|
+
# performance_insights_kms_key_id: "String",
|
1238
1273
|
# })
|
1239
1274
|
#
|
1240
1275
|
# @example Response structure
|
@@ -1309,7 +1344,8 @@ module Aws::DocDB
|
|
1309
1344
|
end
|
1310
1345
|
|
1311
1346
|
# Creates a new subnet group. subnet groups must contain at least one
|
1312
|
-
# subnet in at least two Availability Zones in the
|
1347
|
+
# subnet in at least two Availability Zones in the Amazon Web Services
|
1348
|
+
# Region.
|
1313
1349
|
#
|
1314
1350
|
# @option params [required, String] :db_subnet_group_name
|
1315
1351
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -1492,11 +1528,12 @@ module Aws::DocDB
|
|
1492
1528
|
end
|
1493
1529
|
|
1494
1530
|
# 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
|
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.
|
1500
1537
|
#
|
1501
1538
|
#
|
1502
1539
|
#
|
@@ -1990,7 +2027,7 @@ module Aws::DocDB
|
|
1990
2027
|
end
|
1991
2028
|
|
1992
2029
|
# Returns a list of certificate authority (CA) certificates provided by
|
1993
|
-
# Amazon DocumentDB for this account.
|
2030
|
+
# Amazon DocumentDB for this Amazon Web Services account.
|
1994
2031
|
#
|
1995
2032
|
# @option params [String] :certificate_identifier
|
1996
2033
|
# The user-supplied certificate identifier. If this parameter is
|
@@ -2225,12 +2262,13 @@ module Aws::DocDB
|
|
2225
2262
|
# Returns a list of cluster snapshot attribute names and values for a
|
2226
2263
|
# manual DB cluster snapshot.
|
2227
2264
|
#
|
2228
|
-
# When you share snapshots with other accounts,
|
2265
|
+
# When you share snapshots with other Amazon Web Services accounts,
|
2229
2266
|
# `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
|
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.
|
2234
2272
|
#
|
2235
2273
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
2236
2274
|
# The identifier for the cluster snapshot to describe the attributes
|
@@ -2295,13 +2333,13 @@ module Aws::DocDB
|
|
2295
2333
|
# the following values:
|
2296
2334
|
#
|
2297
2335
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2298
|
-
# has automatically created for your account.
|
2336
|
+
# has automatically created for your Amazon Web Services account.
|
2299
2337
|
#
|
2300
2338
|
# * `manual` - Return all cluster snapshots that you have manually
|
2301
|
-
# created for your account.
|
2339
|
+
# created for your Amazon Web Services account.
|
2302
2340
|
#
|
2303
2341
|
# * `shared` - Return all manual cluster snapshots that have been shared
|
2304
|
-
# to your account.
|
2342
|
+
# to your Amazon Web Services account.
|
2305
2343
|
#
|
2306
2344
|
# * `public` - Return all cluster snapshots that have been marked as
|
2307
2345
|
# public.
|
@@ -2338,13 +2376,14 @@ module Aws::DocDB
|
|
2338
2376
|
#
|
2339
2377
|
# @option params [Boolean] :include_shared
|
2340
2378
|
# Set to `true` to include shared manual cluster snapshots from other
|
2341
|
-
# accounts that this
|
2342
|
-
# 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`.
|
2343
2382
|
#
|
2344
2383
|
# @option params [Boolean] :include_public
|
2345
2384
|
# 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`.
|
2385
|
+
# can be copied or restored by any Amazon Web Services account, and
|
2386
|
+
# otherwise `false`. The default is `false`.
|
2348
2387
|
#
|
2349
2388
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2350
2389
|
#
|
@@ -3607,7 +3646,7 @@ module Aws::DocDB
|
|
3607
3646
|
# parameter.
|
3608
3647
|
#
|
3609
3648
|
# The default is a 30-minute window selected at random from an 8-hour
|
3610
|
-
# block of time for each Region.
|
3649
|
+
# block of time for each Amazon Web Services Region.
|
3611
3650
|
#
|
3612
3651
|
# Constraints:
|
3613
3652
|
#
|
@@ -3626,7 +3665,8 @@ module Aws::DocDB
|
|
3626
3665
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
3627
3666
|
#
|
3628
3667
|
# The default is a 30-minute window selected at random from an 8-hour
|
3629
|
-
# 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.
|
3630
3670
|
#
|
3631
3671
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
3632
3672
|
#
|
@@ -3794,17 +3834,19 @@ module Aws::DocDB
|
|
3794
3834
|
# Adds an attribute and values to, or removes an attribute and values
|
3795
3835
|
# from, a manual cluster snapshot.
|
3796
3836
|
#
|
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
|
-
#
|
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.
|
3808
3850
|
#
|
3809
3851
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
3810
3852
|
# The identifier for the cluster snapshot to modify the attributes for.
|
@@ -3812,29 +3854,31 @@ module Aws::DocDB
|
|
3812
3854
|
# @option params [required, String] :attribute_name
|
3813
3855
|
# The name of the cluster snapshot attribute to modify.
|
3814
3856
|
#
|
3815
|
-
# To manage authorization for other accounts to copy
|
3816
|
-
# 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`.
|
3817
3859
|
#
|
3818
3860
|
# @option params [Array<String>] :values_to_add
|
3819
3861
|
# A list of cluster snapshot attributes to add to the attribute
|
3820
3862
|
# specified by `AttributeName`.
|
3821
3863
|
#
|
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
|
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.
|
3828
3871
|
#
|
3829
3872
|
# @option params [Array<String>] :values_to_remove
|
3830
3873
|
# A list of cluster snapshot attributes to remove from the attribute
|
3831
3874
|
# specified by `AttributeName`.
|
3832
3875
|
#
|
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
|
-
#
|
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`
|
3838
3882
|
# attribute can still copy or restore a manual cluster snapshot.
|
3839
3883
|
#
|
3840
3884
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3882,7 +3926,8 @@ module Aws::DocDB
|
|
3882
3926
|
#
|
3883
3927
|
# @option params [String] :db_instance_class
|
3884
3928
|
# The new compute and memory capacity of the instance; for example,
|
3885
|
-
# `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.
|
3886
3931
|
#
|
3887
3932
|
# If you modify the instance class, an outage occurs during the change.
|
3888
3933
|
# The change is applied during the next maintenance window, unless
|
@@ -3955,6 +4000,27 @@ module Aws::DocDB
|
|
3955
4000
|
#
|
3956
4001
|
# Valid values: 0-15
|
3957
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
|
+
#
|
3958
4024
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3959
4025
|
#
|
3960
4026
|
# * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -3970,6 +4036,8 @@ module Aws::DocDB
|
|
3970
4036
|
# new_db_instance_identifier: "String",
|
3971
4037
|
# ca_certificate_identifier: "String",
|
3972
4038
|
# promotion_tier: 1,
|
4039
|
+
# enable_performance_insights: false,
|
4040
|
+
# performance_insights_kms_key_id: "String",
|
3973
4041
|
# })
|
3974
4042
|
#
|
3975
4043
|
# @example Response structure
|
@@ -4044,7 +4112,8 @@ module Aws::DocDB
|
|
4044
4112
|
end
|
4045
4113
|
|
4046
4114
|
# Modifies an existing subnet group. subnet groups must contain at least
|
4047
|
-
# 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.
|
4048
4117
|
#
|
4049
4118
|
# @option params [required, String] :db_subnet_group_name
|
4050
4119
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -4606,10 +4675,10 @@ module Aws::DocDB
|
|
4606
4675
|
# a DB snapshot or cluster snapshot.
|
4607
4676
|
#
|
4608
4677
|
# 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.
|
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.
|
4613
4682
|
#
|
4614
4683
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4615
4684
|
# following occurs:
|
@@ -4793,10 +4862,10 @@ module Aws::DocDB
|
|
4793
4862
|
# an encrypted cluster.
|
4794
4863
|
#
|
4795
4864
|
# 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.
|
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.
|
4800
4869
|
#
|
4801
4870
|
# You can restore to a new cluster and encrypt the new cluster with an
|
4802
4871
|
# KMS key that is different from the KMS key used to encrypt the source
|
@@ -5069,7 +5138,7 @@ module Aws::DocDB
|
|
5069
5138
|
params: params,
|
5070
5139
|
config: config)
|
5071
5140
|
context[:gem_name] = 'aws-sdk-docdb'
|
5072
|
-
context[:gem_version] = '1.
|
5141
|
+
context[:gem_version] = '1.42.0'
|
5073
5142
|
Seahorse::Client::Request.new(handlers, context)
|
5074
5143
|
end
|
5075
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: 2022-
|
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
|