aws-sdk-docdb 1.31.0 → 1.35.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-docdb/client.rb +123 -137
- data/lib/aws-sdk-docdb/types.rb +148 -153
- data/lib/aws-sdk-docdb.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8893eaa84e013c419a3d6b9da305dc93f2bd0b2bce4ddad4a92ea60d22e27f87
|
4
|
+
data.tar.gz: af0a5afeb15341531af086d265ac1e4c24456476abd14cbb517a78f1718fe4a4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a9e10f9450f177273e39c25412df6c340a218ea5aed84a2b9c535eb7684f90b8980a4421b8bd03506700f174d30ae8dca375fcb59eb494c3afe9bbd00638e664
|
7
|
+
data.tar.gz: cc0e5815e790997c80909a8803ecd88c0bb69db151a8cf4fd16dcbf8722880cdb43588092c64e1b09952d97ed7fc7160376c68ed1f929ce9146db02ce343b97d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.35.0 (2021-09-01)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.34.0 (2021-07-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.33.0 (2021-07-28)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.32.0 (2021-06-23)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - DocumentDB documentation-only edits
|
23
|
+
|
4
24
|
1.31.0 (2021-06-02)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.35.0
|
data/lib/aws-sdk-docdb/client.rb
CHANGED
@@ -388,8 +388,8 @@ module Aws::DocDB
|
|
388
388
|
|
389
389
|
# Adds metadata tags to an Amazon DocumentDB resource. You can use these
|
390
390
|
# tags with cost allocation reporting to track costs that are associated
|
391
|
-
# with Amazon DocumentDB resources
|
392
|
-
#
|
391
|
+
# with Amazon DocumentDB resources or in a `Condition` statement in an
|
392
|
+
# Identity and Access Management (IAM) policy for Amazon DocumentDB.
|
393
393
|
#
|
394
394
|
# @option params [required, String] :resource_name
|
395
395
|
# The Amazon DocumentDB resource that the tags are added to. This value
|
@@ -489,11 +489,11 @@ module Aws::DocDB
|
|
489
489
|
#
|
490
490
|
# * Must specify a valid cluster parameter group.
|
491
491
|
#
|
492
|
-
# * If the source cluster parameter group is in the same
|
493
|
-
#
|
492
|
+
# * If the source cluster parameter group is in the same Region as the
|
493
|
+
# copy, specify a valid parameter group identifier; for example,
|
494
494
|
# `my-db-cluster-param-group`, or a valid ARN.
|
495
495
|
#
|
496
|
-
# * If the source parameter group is in a different
|
496
|
+
# * If the source parameter group is in a different Region than the
|
497
497
|
# copy, specify a valid cluster parameter group ARN; for example,
|
498
498
|
# `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
|
499
499
|
#
|
@@ -557,7 +557,7 @@ module Aws::DocDB
|
|
557
557
|
# To copy a cluster snapshot from a shared manual cluster snapshot,
|
558
558
|
# `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
|
559
559
|
# (ARN) of the shared cluster snapshot. You can only copy a shared DB
|
560
|
-
# cluster snapshot, whether encrypted or not, in the same
|
560
|
+
# cluster snapshot, whether encrypted or not, in the same Region.
|
561
561
|
#
|
562
562
|
# To cancel the copy operation after it is in progress, delete the
|
563
563
|
# target cluster snapshot identified by
|
@@ -572,10 +572,10 @@ module Aws::DocDB
|
|
572
572
|
#
|
573
573
|
# * Must specify a valid system snapshot in the *available* state.
|
574
574
|
#
|
575
|
-
# * If the source snapshot is in the same
|
576
|
-
#
|
575
|
+
# * If the source snapshot is in the same Region as the copy, specify a
|
576
|
+
# valid snapshot identifier.
|
577
577
|
#
|
578
|
-
# * If the source snapshot is in a different
|
578
|
+
# * If the source snapshot is in a different Region than the copy,
|
579
579
|
# specify a valid cluster snapshot ARN.
|
580
580
|
#
|
581
581
|
# Example: `my-cluster-snapshot1`
|
@@ -595,54 +595,53 @@ module Aws::DocDB
|
|
595
595
|
# Example: `my-cluster-snapshot2`
|
596
596
|
#
|
597
597
|
# @option params [String] :kms_key_id
|
598
|
-
# The
|
599
|
-
#
|
600
|
-
#
|
598
|
+
# The KMS key ID for an encrypted cluster snapshot. The KMS key ID is
|
599
|
+
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
600
|
+
# alias for the KMS encryption key.
|
601
601
|
#
|
602
|
-
# If you copy an encrypted cluster snapshot from your
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
602
|
+
# If you copy an encrypted cluster snapshot from your account, you can
|
603
|
+
# specify a value for `KmsKeyId` to encrypt the copy with a new KMS
|
604
|
+
# encryption key. If you don't specify a value for `KmsKeyId`, then the
|
605
|
+
# copy of the cluster snapshot is encrypted with the same KMS key as the
|
606
|
+
# source cluster snapshot.
|
607
607
|
#
|
608
608
|
# If you copy an encrypted cluster snapshot that is shared from another
|
609
|
-
#
|
609
|
+
# account, then you must specify a value for `KmsKeyId`.
|
610
610
|
#
|
611
|
-
# To copy an encrypted cluster snapshot to another
|
612
|
-
# `KmsKeyId` to the
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
# AWS Region.
|
611
|
+
# To copy an encrypted cluster snapshot to another Region, set
|
612
|
+
# `KmsKeyId` to the KMS key ID that you want to use to encrypt the copy
|
613
|
+
# of the cluster snapshot in the destination Region. KMS encryption keys
|
614
|
+
# are specific to the Region that they are created in, and you can't
|
615
|
+
# use encryption keys from one Region in another Region.
|
617
616
|
#
|
618
617
|
# If you copy an unencrypted cluster snapshot and specify a value for
|
619
618
|
# the `KmsKeyId` parameter, an error is returned.
|
620
619
|
#
|
621
620
|
# @option params [String] :pre_signed_url
|
622
|
-
# The URL that contains a Signature Version 4 signed request for
|
623
|
-
# `CopyDBClusterSnapshot` API action in the
|
621
|
+
# The URL that contains a Signature Version 4 signed request for
|
622
|
+
# the`CopyDBClusterSnapshot` API action in the Region that contains the
|
624
623
|
# source cluster snapshot to copy. You must use the `PreSignedUrl`
|
625
|
-
# parameter when copying a cluster snapshot from another
|
624
|
+
# parameter when copying a cluster snapshot from another Region.
|
626
625
|
#
|
627
|
-
# If you are using an
|
628
|
-
# `SourceRegion` (or `--source-region` for the
|
626
|
+
# If you are using an Amazon Web Services SDK tool or the CLI, you can
|
627
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
629
628
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
630
629
|
# autogenerates a pre-signed URL that is a valid request for the
|
631
|
-
# operation that can be executed in the source
|
630
|
+
# operation that can be executed in the source Region.
|
632
631
|
#
|
633
632
|
# The presigned URL must be a valid request for the
|
634
633
|
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
635
|
-
#
|
636
|
-
#
|
634
|
+
# Region that contains the cluster snapshot to be copied. The presigned
|
635
|
+
# URL request must contain the following parameter values:
|
637
636
|
#
|
638
637
|
# * `SourceRegion` - The ID of the region that contains the snapshot to
|
639
638
|
# be copied.
|
640
639
|
#
|
641
640
|
# * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
|
642
641
|
# encrypted cluster snapshot to be copied. This identifier must be in
|
643
|
-
# the Amazon Resource Name (ARN) format for the source
|
642
|
+
# the Amazon Resource Name (ARN) format for the source Region. For
|
644
643
|
# example, if you are copying an encrypted cluster snapshot from the
|
645
|
-
# us-east-1
|
644
|
+
# us-east-1 Region, then your `SourceDBClusterSnapshotIdentifier`
|
646
645
|
# looks something like the following:
|
647
646
|
# `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
|
648
647
|
#
|
@@ -766,10 +765,10 @@ module Aws::DocDB
|
|
766
765
|
# Valid values: `docdb`
|
767
766
|
#
|
768
767
|
# @option params [String] :engine_version
|
769
|
-
# The version number of the database engine to use. The
|
770
|
-
# will default to the latest major engine version.
|
771
|
-
# workloads, we recommend explicitly declaring this
|
772
|
-
# intended major engine version.
|
768
|
+
# The version number of the database engine to use. The
|
769
|
+
# `--engine-version` will default to the latest major engine version.
|
770
|
+
# For production workloads, we recommend explicitly declaring this
|
771
|
+
# parameter with the intended major engine version.
|
773
772
|
#
|
774
773
|
# @option params [Integer] :port
|
775
774
|
# The port number on which the instances in the cluster accept
|
@@ -799,7 +798,7 @@ module Aws::DocDB
|
|
799
798
|
# parameter.
|
800
799
|
#
|
801
800
|
# The default is a 30-minute window selected at random from an 8-hour
|
802
|
-
# block of time for each
|
801
|
+
# block of time for each Region.
|
803
802
|
#
|
804
803
|
# Constraints:
|
805
804
|
#
|
@@ -818,8 +817,7 @@ module Aws::DocDB
|
|
818
817
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
819
818
|
#
|
820
819
|
# The default is a 30-minute window selected at random from an 8-hour
|
821
|
-
# block of time for each
|
822
|
-
# week.
|
820
|
+
# block of time for each Region, occurring on a random day of the week.
|
823
821
|
#
|
824
822
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
825
823
|
#
|
@@ -832,13 +830,13 @@ module Aws::DocDB
|
|
832
830
|
# Specifies whether the cluster is encrypted.
|
833
831
|
#
|
834
832
|
# @option params [String] :kms_key_id
|
835
|
-
# The
|
833
|
+
# The KMS key identifier for an encrypted cluster.
|
836
834
|
#
|
837
|
-
# The
|
838
|
-
#
|
839
|
-
#
|
840
|
-
#
|
841
|
-
#
|
835
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
836
|
+
# encryption key. If you are creating a cluster using the same account
|
837
|
+
# that owns the KMS encryption key that is used to encrypt the new
|
838
|
+
# cluster, you can use the KMS key alias instead of the ARN for the KMS
|
839
|
+
# encryption key.
|
842
840
|
#
|
843
841
|
# If an encryption key is not specified in `KmsKeyId`\:
|
844
842
|
#
|
@@ -847,9 +845,8 @@ module Aws::DocDB
|
|
847
845
|
#
|
848
846
|
# ^
|
849
847
|
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
# Region.
|
848
|
+
# KMS creates the default encryption key for your account. Your account
|
849
|
+
# has a different default encryption key for each Regions.
|
853
850
|
#
|
854
851
|
# @option params [String] :pre_signed_url
|
855
852
|
# Not currently supported.
|
@@ -1154,7 +1151,7 @@ module Aws::DocDB
|
|
1154
1151
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
1155
1152
|
#
|
1156
1153
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1157
|
-
#
|
1154
|
+
# Region.
|
1158
1155
|
#
|
1159
1156
|
# Example: `us-east-1d`
|
1160
1157
|
#
|
@@ -1165,18 +1162,17 @@ module Aws::DocDB
|
|
1165
1162
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
1166
1163
|
#
|
1167
1164
|
# The default is a 30-minute window selected at random from an 8-hour
|
1168
|
-
# block of time for each
|
1169
|
-
# week.
|
1165
|
+
# block of time for each Region, occurring on a random day of the week.
|
1170
1166
|
#
|
1171
1167
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
1172
1168
|
#
|
1173
1169
|
# Constraints: Minimum 30-minute window.
|
1174
1170
|
#
|
1175
1171
|
# @option params [Boolean] :auto_minor_version_upgrade
|
1176
|
-
#
|
1177
|
-
#
|
1172
|
+
# This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
|
1173
|
+
# does not perform minor version upgrades regardless of the value set.
|
1178
1174
|
#
|
1179
|
-
# Default: `
|
1175
|
+
# Default: `false`
|
1180
1176
|
#
|
1181
1177
|
# @option params [Array<Types::Tag>] :tags
|
1182
1178
|
# The tags to be assigned to the instance. You can assign up to 10 tags
|
@@ -1289,7 +1285,7 @@ module Aws::DocDB
|
|
1289
1285
|
end
|
1290
1286
|
|
1291
1287
|
# Creates a new subnet group. subnet groups must contain at least one
|
1292
|
-
# subnet in at least two Availability Zones in the
|
1288
|
+
# subnet in at least two Availability Zones in the Region.
|
1293
1289
|
#
|
1294
1290
|
# @option params [required, String] :db_subnet_group_name
|
1295
1291
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -1390,7 +1386,7 @@ module Aws::DocDB
|
|
1390
1386
|
# events are returned.
|
1391
1387
|
#
|
1392
1388
|
# Valid values: `db-instance`, `db-cluster`, `db-parameter-group`,
|
1393
|
-
# `db-security-group`, `db-
|
1389
|
+
# `db-security-group`, `db-cluster-snapshot`
|
1394
1390
|
#
|
1395
1391
|
# @option params [Array<String>] :event_categories
|
1396
1392
|
# A list of event categories for a `SourceType` that you want to
|
@@ -1472,11 +1468,11 @@ module Aws::DocDB
|
|
1472
1468
|
end
|
1473
1469
|
|
1474
1470
|
# Creates an Amazon DocumentDB global cluster that can span multiple
|
1475
|
-
# multiple
|
1476
|
-
#
|
1477
|
-
#
|
1478
|
-
#
|
1479
|
-
#
|
1471
|
+
# multiple Regions. The global cluster contains one primary cluster with
|
1472
|
+
# read-write capability, and up-to give read-only secondary clusters.
|
1473
|
+
# Global clusters uses storage-based fast replication across regions
|
1474
|
+
# with latencies less than one second, using dedicated infrastructure
|
1475
|
+
# with no impact to your workload’s performance.
|
1480
1476
|
#
|
1481
1477
|
#
|
1482
1478
|
#
|
@@ -1970,7 +1966,7 @@ module Aws::DocDB
|
|
1970
1966
|
end
|
1971
1967
|
|
1972
1968
|
# Returns a list of certificate authority (CA) certificates provided by
|
1973
|
-
# Amazon DocumentDB for this
|
1969
|
+
# Amazon DocumentDB for this account.
|
1974
1970
|
#
|
1975
1971
|
# @option params [String] :certificate_identifier
|
1976
1972
|
# The user-supplied certificate identifier. If this parameter is
|
@@ -2205,12 +2201,12 @@ module Aws::DocDB
|
|
2205
2201
|
# Returns a list of cluster snapshot attribute names and values for a
|
2206
2202
|
# manual DB cluster snapshot.
|
2207
2203
|
#
|
2208
|
-
# When you share snapshots with other
|
2204
|
+
# When you share snapshots with other accounts,
|
2209
2205
|
# `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
|
2210
|
-
# and a list of IDs for the
|
2206
|
+
# and a list of IDs for the accounts that are authorized to copy or
|
2211
2207
|
# restore the manual cluster snapshot. If `all` is included in the list
|
2212
2208
|
# of values for the `restore` attribute, then the manual cluster
|
2213
|
-
# snapshot is public and can be copied or restored by all
|
2209
|
+
# snapshot is public and can be copied or restored by all accounts.
|
2214
2210
|
#
|
2215
2211
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
2216
2212
|
# The identifier for the cluster snapshot to describe the attributes
|
@@ -2275,13 +2271,13 @@ module Aws::DocDB
|
|
2275
2271
|
# the following values:
|
2276
2272
|
#
|
2277
2273
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2278
|
-
# has automatically created for your
|
2274
|
+
# has automatically created for your account.
|
2279
2275
|
#
|
2280
2276
|
# * `manual` - Return all cluster snapshots that you have manually
|
2281
|
-
# created for your
|
2277
|
+
# created for your account.
|
2282
2278
|
#
|
2283
2279
|
# * `shared` - Return all manual cluster snapshots that have been shared
|
2284
|
-
# to your
|
2280
|
+
# to your account.
|
2285
2281
|
#
|
2286
2282
|
# * `public` - Return all cluster snapshots that have been marked as
|
2287
2283
|
# public.
|
@@ -2318,13 +2314,13 @@ module Aws::DocDB
|
|
2318
2314
|
#
|
2319
2315
|
# @option params [Boolean] :include_shared
|
2320
2316
|
# Set to `true` to include shared manual cluster snapshots from other
|
2321
|
-
#
|
2322
|
-
#
|
2317
|
+
# accounts that this account has been given permission to copy or
|
2318
|
+
# restore, and otherwise `false`. The default is `false`.
|
2323
2319
|
#
|
2324
2320
|
# @option params [Boolean] :include_public
|
2325
2321
|
# Set to `true` to include manual cluster snapshots that are public and
|
2326
|
-
# can be copied or restored by any
|
2327
|
-
#
|
2322
|
+
# can be copied or restored by any account, and otherwise `false`. The
|
2323
|
+
# default is `false`.
|
2328
2324
|
#
|
2329
2325
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2330
2326
|
#
|
@@ -2895,8 +2891,7 @@ module Aws::DocDB
|
|
2895
2891
|
# @option params [String] :source_type
|
2896
2892
|
# The type of source that is generating the events.
|
2897
2893
|
#
|
2898
|
-
# Valid values: `db-instance`, `db-parameter-group`,
|
2899
|
-
# `db-security-group`, `db-snapshot`
|
2894
|
+
# Valid values: `db-instance`, `db-parameter-group`, `db-security-group`
|
2900
2895
|
#
|
2901
2896
|
# @option params [Array<Types::Filter>] :filters
|
2902
2897
|
# This parameter is not currently supported.
|
@@ -3588,7 +3583,7 @@ module Aws::DocDB
|
|
3588
3583
|
# parameter.
|
3589
3584
|
#
|
3590
3585
|
# The default is a 30-minute window selected at random from an 8-hour
|
3591
|
-
# block of time for each
|
3586
|
+
# block of time for each Region.
|
3592
3587
|
#
|
3593
3588
|
# Constraints:
|
3594
3589
|
#
|
@@ -3607,8 +3602,7 @@ module Aws::DocDB
|
|
3607
3602
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
3608
3603
|
#
|
3609
3604
|
# The default is a 30-minute window selected at random from an 8-hour
|
3610
|
-
# block of time for each
|
3611
|
-
# week.
|
3605
|
+
# block of time for each Region, occurring on a random day of the week.
|
3612
3606
|
#
|
3613
3607
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
3614
3608
|
#
|
@@ -3774,19 +3768,19 @@ module Aws::DocDB
|
|
3774
3768
|
end
|
3775
3769
|
|
3776
3770
|
# Adds an attribute and values to, or removes an attribute and values
|
3777
|
-
# from, a manual
|
3771
|
+
# from, a manual cluster snapshot.
|
3778
3772
|
#
|
3779
|
-
# To share a manual cluster snapshot with other
|
3773
|
+
# To share a manual cluster snapshot with other accounts, specify
|
3780
3774
|
# `restore` as the `AttributeName`, and use the `ValuesToAdd` parameter
|
3781
|
-
# to add a list of IDs of the
|
3782
|
-
#
|
3783
|
-
#
|
3784
|
-
#
|
3785
|
-
#
|
3786
|
-
#
|
3787
|
-
#
|
3788
|
-
#
|
3789
|
-
#
|
3775
|
+
# to add a list of IDs of the accounts that are authorized to restore
|
3776
|
+
# the manual cluster snapshot. Use the value `all` to make the manual
|
3777
|
+
# cluster snapshot public, which means that it can be copied or restored
|
3778
|
+
# by all accounts. Do not add the `all` value for any manual cluster
|
3779
|
+
# snapshots that contain private information that you don't want
|
3780
|
+
# available to all accounts. If a manual cluster snapshot is encrypted,
|
3781
|
+
# it can be shared, but only by specifying a list of authorized account
|
3782
|
+
# IDs for the `ValuesToAdd` parameter. You can't use `all` as a value
|
3783
|
+
# for that parameter in this case.
|
3790
3784
|
#
|
3791
3785
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
3792
3786
|
# The identifier for the cluster snapshot to modify the attributes for.
|
@@ -3794,31 +3788,30 @@ module Aws::DocDB
|
|
3794
3788
|
# @option params [required, String] :attribute_name
|
3795
3789
|
# The name of the cluster snapshot attribute to modify.
|
3796
3790
|
#
|
3797
|
-
# To manage authorization for other
|
3798
|
-
#
|
3791
|
+
# To manage authorization for other accounts to copy or restore a manual
|
3792
|
+
# cluster snapshot, set this value to `restore`.
|
3799
3793
|
#
|
3800
3794
|
# @option params [Array<String>] :values_to_add
|
3801
3795
|
# A list of cluster snapshot attributes to add to the attribute
|
3802
3796
|
# specified by `AttributeName`.
|
3803
3797
|
#
|
3804
|
-
# To authorize other
|
3805
|
-
# snapshot, set this list to include one or more
|
3806
|
-
#
|
3807
|
-
#
|
3798
|
+
# To authorize other accounts to copy or restore a manual cluster
|
3799
|
+
# snapshot, set this list to include one or more account IDs. To make
|
3800
|
+
# the manual cluster snapshot restorable by any account, set it to
|
3801
|
+
# `all`. Do not add the `all` value for any manual cluster snapshots
|
3808
3802
|
# that contain private information that you don't want to be available
|
3809
|
-
# to all
|
3803
|
+
# to all accounts.
|
3810
3804
|
#
|
3811
3805
|
# @option params [Array<String>] :values_to_remove
|
3812
3806
|
# A list of cluster snapshot attributes to remove from the attribute
|
3813
3807
|
# specified by `AttributeName`.
|
3814
3808
|
#
|
3815
|
-
# To remove authorization for other
|
3816
|
-
#
|
3817
|
-
#
|
3818
|
-
#
|
3819
|
-
#
|
3820
|
-
#
|
3821
|
-
# snapshot.
|
3809
|
+
# To remove authorization for other accounts to copy or restore a manual
|
3810
|
+
# cluster snapshot, set this list to include one or more account
|
3811
|
+
# identifiers. To remove authorization for any account to copy or
|
3812
|
+
# restore the cluster snapshot, set it to `all` . If you specify `all`,
|
3813
|
+
# an account whose account ID is explicitly added to the `restore`
|
3814
|
+
# attribute can still copy or restore a manual cluster snapshot.
|
3822
3815
|
#
|
3823
3816
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3824
3817
|
#
|
@@ -3865,8 +3858,7 @@ module Aws::DocDB
|
|
3865
3858
|
#
|
3866
3859
|
# @option params [String] :db_instance_class
|
3867
3860
|
# The new compute and memory capacity of the instance; for example,
|
3868
|
-
# `db.r5.large`. Not all instance classes are available in all
|
3869
|
-
# Regions.
|
3861
|
+
# `db.r5.large`. Not all instance classes are available in all Regions.
|
3870
3862
|
#
|
3871
3863
|
# If you modify the instance class, an outage occurs during the change.
|
3872
3864
|
# The change is applied during the next maintenance window, unless
|
@@ -3906,13 +3898,8 @@ module Aws::DocDB
|
|
3906
3898
|
# Constraints: Must be at least 30 minutes.
|
3907
3899
|
#
|
3908
3900
|
# @option params [Boolean] :auto_minor_version_upgrade
|
3909
|
-
#
|
3910
|
-
#
|
3911
|
-
# doesn't result in an outage except in the following case, and the
|
3912
|
-
# change is asynchronously applied as soon as possible. An outage
|
3913
|
-
# results if this parameter is set to `true` during the maintenance
|
3914
|
-
# window, and a newer minor version is available, and Amazon DocumentDB
|
3915
|
-
# has enabled automatic patching for that engine version.
|
3901
|
+
# This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB
|
3902
|
+
# does not perform minor version upgrades regardless of the value set.
|
3916
3903
|
#
|
3917
3904
|
# @option params [String] :new_db_instance_identifier
|
3918
3905
|
# The new instance identifier for the instance when renaming an
|
@@ -4033,7 +4020,7 @@ module Aws::DocDB
|
|
4033
4020
|
end
|
4034
4021
|
|
4035
4022
|
# Modifies an existing subnet group. subnet groups must contain at least
|
4036
|
-
# one subnet in at least two Availability Zones in the
|
4023
|
+
# one subnet in at least two Availability Zones in the Region.
|
4037
4024
|
#
|
4038
4025
|
# @option params [required, String] :db_subnet_group_name
|
4039
4026
|
# The name for the subnet group. This value is stored as a lowercase
|
@@ -4100,8 +4087,7 @@ module Aws::DocDB
|
|
4100
4087
|
# parameter to `db-instance`. If this value is not specified, all events
|
4101
4088
|
# are returned.
|
4102
4089
|
#
|
4103
|
-
# Valid values: `db-instance`, `db-parameter-group`,
|
4104
|
-
# `db-security-group`, `db-snapshot`
|
4090
|
+
# Valid values: `db-instance`, `db-parameter-group`, `db-security-group`
|
4105
4091
|
#
|
4106
4092
|
# @option params [Array<String>] :event_categories
|
4107
4093
|
# A list of event categories for a `SourceType` that you want to
|
@@ -4592,21 +4578,21 @@ module Aws::DocDB
|
|
4592
4578
|
# The tags to be assigned to the restored cluster.
|
4593
4579
|
#
|
4594
4580
|
# @option params [String] :kms_key_id
|
4595
|
-
# The
|
4596
|
-
#
|
4581
|
+
# The KMS key identifier to use when restoring an encrypted cluster from
|
4582
|
+
# a DB snapshot or cluster snapshot.
|
4597
4583
|
#
|
4598
|
-
# The
|
4599
|
-
#
|
4600
|
-
#
|
4601
|
-
#
|
4602
|
-
#
|
4584
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4585
|
+
# encryption key. If you are restoring a cluster with the same account
|
4586
|
+
# that owns the KMS encryption key used to encrypt the new cluster, then
|
4587
|
+
# you can use the KMS key alias instead of the ARN for the KMS
|
4588
|
+
# encryption key.
|
4603
4589
|
#
|
4604
4590
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4605
4591
|
# following occurs:
|
4606
4592
|
#
|
4607
4593
|
# * If the snapshot or cluster snapshot in `SnapshotIdentifier` is
|
4608
|
-
# encrypted, then the restored cluster is encrypted using the
|
4609
|
-
#
|
4594
|
+
# encrypted, then the restored cluster is encrypted using the KMS key
|
4595
|
+
# that was used to encrypt the snapshot or the cluster snapshot.
|
4610
4596
|
#
|
4611
4597
|
# * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is
|
4612
4598
|
# not encrypted, then the restored DB cluster is not encrypted.
|
@@ -4779,25 +4765,25 @@ module Aws::DocDB
|
|
4779
4765
|
# The tags to be assigned to the restored cluster.
|
4780
4766
|
#
|
4781
4767
|
# @option params [String] :kms_key_id
|
4782
|
-
# The
|
4783
|
-
#
|
4768
|
+
# The KMS key identifier to use when restoring an encrypted cluster from
|
4769
|
+
# an encrypted cluster.
|
4784
4770
|
#
|
4785
|
-
# The
|
4786
|
-
#
|
4787
|
-
#
|
4788
|
-
#
|
4789
|
-
#
|
4771
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
4772
|
+
# encryption key. If you are restoring a cluster with the same account
|
4773
|
+
# that owns the KMS encryption key used to encrypt the new cluster, then
|
4774
|
+
# you can use the KMS key alias instead of the ARN for the KMS
|
4775
|
+
# encryption key.
|
4790
4776
|
#
|
4791
4777
|
# You can restore to a new cluster and encrypt the new cluster with an
|
4792
|
-
#
|
4793
|
-
#
|
4794
|
-
#
|
4778
|
+
# KMS key that is different from the KMS key used to encrypt the source
|
4779
|
+
# cluster. The new DB cluster is encrypted with the KMS key identified
|
4780
|
+
# by the `KmsKeyId` parameter.
|
4795
4781
|
#
|
4796
4782
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4797
4783
|
# following occurs:
|
4798
4784
|
#
|
4799
4785
|
# * If the cluster is encrypted, then the restored cluster is encrypted
|
4800
|
-
# using the
|
4786
|
+
# using the KMS key that was used to encrypt the source cluster.
|
4801
4787
|
#
|
4802
4788
|
# * If the cluster is not encrypted, then the restored cluster is not
|
4803
4789
|
# encrypted.
|
@@ -5059,7 +5045,7 @@ module Aws::DocDB
|
|
5059
5045
|
params: params,
|
5060
5046
|
config: config)
|
5061
5047
|
context[:gem_name] = 'aws-sdk-docdb'
|
5062
|
-
context[:gem_version] = '1.
|
5048
|
+
context[:gem_version] = '1.35.0'
|
5063
5049
|
Seahorse::Client::Request.new(handlers, context)
|
5064
5050
|
end
|
5065
5051
|
|
data/lib/aws-sdk-docdb/types.rb
CHANGED
@@ -179,7 +179,7 @@ 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 account.
|
183
183
|
#
|
184
184
|
# @!attribute [rw] certificate_identifier
|
185
185
|
# The unique key that identifies a certificate.
|
@@ -229,7 +229,7 @@ module Aws::DocDB
|
|
229
229
|
end
|
230
230
|
|
231
231
|
# @!attribute [rw] certificates
|
232
|
-
# A list of certificates for this
|
232
|
+
# A list of certificates for this account.
|
233
233
|
# @return [Array<Types::Certificate>]
|
234
234
|
#
|
235
235
|
# @!attribute [rw] marker
|
@@ -312,13 +312,12 @@ module Aws::DocDB
|
|
312
312
|
#
|
313
313
|
# * Must specify a valid cluster parameter group.
|
314
314
|
#
|
315
|
-
# * If the source cluster parameter group is in the same
|
316
|
-
#
|
315
|
+
# * If the source cluster parameter group is in the same Region as the
|
316
|
+
# copy, specify a valid parameter group identifier; for example,
|
317
317
|
# `my-db-cluster-param-group`, or a valid ARN.
|
318
318
|
#
|
319
|
-
# * If the source parameter group is in a different
|
320
|
-
#
|
321
|
-
# example,
|
319
|
+
# * If the source parameter group is in a different Region than the
|
320
|
+
# copy, specify a valid cluster parameter group ARN; for example,
|
322
321
|
# `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
|
323
322
|
# @return [String]
|
324
323
|
#
|
@@ -397,10 +396,10 @@ module Aws::DocDB
|
|
397
396
|
#
|
398
397
|
# * Must specify a valid system snapshot in the *available* state.
|
399
398
|
#
|
400
|
-
# * If the source snapshot is in the same
|
401
|
-
#
|
399
|
+
# * If the source snapshot is in the same Region as the copy, specify
|
400
|
+
# a valid snapshot identifier.
|
402
401
|
#
|
403
|
-
# * If the source snapshot is in a different
|
402
|
+
# * If the source snapshot is in a different Region than the copy,
|
404
403
|
# specify a valid cluster snapshot ARN.
|
405
404
|
#
|
406
405
|
# Example: `my-cluster-snapshot1`
|
@@ -422,56 +421,55 @@ module Aws::DocDB
|
|
422
421
|
# @return [String]
|
423
422
|
#
|
424
423
|
# @!attribute [rw] kms_key_id
|
425
|
-
# The
|
426
|
-
#
|
427
|
-
#
|
424
|
+
# The KMS key ID for an encrypted cluster snapshot. The KMS key ID is
|
425
|
+
# the Amazon Resource Name (ARN), KMS key identifier, or the KMS key
|
426
|
+
# alias for the KMS encryption key.
|
428
427
|
#
|
429
|
-
# If you copy an encrypted cluster snapshot from your
|
430
|
-
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
428
|
+
# If you copy an encrypted cluster snapshot from your account, you can
|
429
|
+
# specify a value for `KmsKeyId` to encrypt the copy with a new KMS
|
430
|
+
# encryption key. If you don't specify a value for `KmsKeyId`, then
|
431
|
+
# the copy of the cluster snapshot is encrypted with the same KMS key
|
432
|
+
# as the source cluster snapshot.
|
434
433
|
#
|
435
434
|
# If you copy an encrypted cluster snapshot that is shared from
|
436
|
-
# another
|
435
|
+
# another account, then you must specify a value for `KmsKeyId`.
|
437
436
|
#
|
438
|
-
# To copy an encrypted cluster snapshot to another
|
439
|
-
# `KmsKeyId` to the
|
440
|
-
# copy of the cluster snapshot in the destination Region.
|
441
|
-
# encryption keys are specific to the
|
442
|
-
#
|
443
|
-
#
|
437
|
+
# To copy an encrypted cluster snapshot to another Region, set
|
438
|
+
# `KmsKeyId` to the KMS key ID that you want to use to encrypt the
|
439
|
+
# copy of the cluster snapshot in the destination Region. KMS
|
440
|
+
# encryption keys are specific to the Region that they are created in,
|
441
|
+
# and you can't use encryption keys from one Region in another
|
442
|
+
# Region.
|
444
443
|
#
|
445
444
|
# If you copy an unencrypted cluster snapshot and specify a value for
|
446
445
|
# the `KmsKeyId` parameter, an error is returned.
|
447
446
|
# @return [String]
|
448
447
|
#
|
449
448
|
# @!attribute [rw] pre_signed_url
|
450
|
-
# The URL that contains a Signature Version 4 signed request for
|
451
|
-
# `CopyDBClusterSnapshot` API action in the
|
449
|
+
# The URL that contains a Signature Version 4 signed request for
|
450
|
+
# the`CopyDBClusterSnapshot` API action in the Region that contains
|
452
451
|
# the source cluster snapshot to copy. You must use the `PreSignedUrl`
|
453
|
-
# parameter when copying a cluster snapshot from another
|
452
|
+
# parameter when copying a cluster snapshot from another Region.
|
454
453
|
#
|
455
|
-
# If you are using an
|
456
|
-
# `SourceRegion` (or `--source-region` for the
|
454
|
+
# If you are using an Amazon Web Services SDK tool or the CLI, you can
|
455
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
457
456
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
458
457
|
# autogenerates a pre-signed URL that is a valid request for the
|
459
|
-
# operation that can be executed in the source
|
458
|
+
# operation that can be executed in the source Region.
|
460
459
|
#
|
461
460
|
# The presigned URL must be a valid request for the
|
462
461
|
# `CopyDBClusterSnapshot` API action that can be executed in the
|
463
|
-
# source
|
464
|
-
#
|
465
|
-
# values:
|
462
|
+
# source Region that contains the cluster snapshot to be copied. The
|
463
|
+
# presigned URL request must contain the following parameter values:
|
466
464
|
#
|
467
465
|
# * `SourceRegion` - The ID of the region that contains the snapshot
|
468
466
|
# to be copied.
|
469
467
|
#
|
470
468
|
# * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
|
471
469
|
# encrypted cluster snapshot to be copied. This identifier must be
|
472
|
-
# in the Amazon Resource Name (ARN) format for the source
|
473
|
-
#
|
474
|
-
#
|
470
|
+
# in the Amazon Resource Name (ARN) format for the source Region.
|
471
|
+
# For example, if you are copying an encrypted cluster snapshot from
|
472
|
+
# the us-east-1 Region, then your
|
475
473
|
# `SourceDBClusterSnapshotIdentifier` looks something like the
|
476
474
|
# following:
|
477
475
|
# `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
|
@@ -615,7 +613,7 @@ module Aws::DocDB
|
|
615
613
|
#
|
616
614
|
# @!attribute [rw] engine_version
|
617
615
|
# The version number of the database engine to use. The
|
618
|
-
#
|
616
|
+
# `--engine-version` will default to the latest major engine version.
|
619
617
|
# For production workloads, we recommend explicitly declaring this
|
620
618
|
# parameter with the intended major engine version.
|
621
619
|
# @return [String]
|
@@ -651,7 +649,7 @@ module Aws::DocDB
|
|
651
649
|
# parameter.
|
652
650
|
#
|
653
651
|
# The default is a 30-minute window selected at random from an 8-hour
|
654
|
-
# block of time for each
|
652
|
+
# block of time for each Region.
|
655
653
|
#
|
656
654
|
# Constraints:
|
657
655
|
#
|
@@ -671,7 +669,7 @@ module Aws::DocDB
|
|
671
669
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
672
670
|
#
|
673
671
|
# The default is a 30-minute window selected at random from an 8-hour
|
674
|
-
# block of time for each
|
672
|
+
# block of time for each Region, occurring on a random day of the
|
675
673
|
# week.
|
676
674
|
#
|
677
675
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
@@ -688,13 +686,13 @@ module Aws::DocDB
|
|
688
686
|
# @return [Boolean]
|
689
687
|
#
|
690
688
|
# @!attribute [rw] kms_key_id
|
691
|
-
# The
|
689
|
+
# The KMS key identifier for an encrypted cluster.
|
692
690
|
#
|
693
|
-
# The
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
697
|
-
#
|
691
|
+
# 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 account
|
693
|
+
# that owns the KMS encryption key that is used to encrypt the new
|
694
|
+
# cluster, you can use the KMS key alias instead of the ARN for the
|
695
|
+
# KMS encryption key.
|
698
696
|
#
|
699
697
|
# If an encryption key is not specified in `KmsKeyId`\:
|
700
698
|
#
|
@@ -703,9 +701,8 @@ module Aws::DocDB
|
|
703
701
|
#
|
704
702
|
# ^
|
705
703
|
#
|
706
|
-
#
|
707
|
-
#
|
708
|
-
# Region.
|
704
|
+
# KMS creates the default encryption key for your account. Your
|
705
|
+
# account has a different default encryption key for each Regions.
|
709
706
|
# @return [String]
|
710
707
|
#
|
711
708
|
# @!attribute [rw] pre_signed_url
|
@@ -969,7 +966,7 @@ module Aws::DocDB
|
|
969
966
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
970
967
|
#
|
971
968
|
# Default: A random, system-chosen Availability Zone in the
|
972
|
-
# endpoint's
|
969
|
+
# endpoint's Region.
|
973
970
|
#
|
974
971
|
# Example: `us-east-1d`
|
975
972
|
# @return [String]
|
@@ -981,7 +978,7 @@ module Aws::DocDB
|
|
981
978
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
982
979
|
#
|
983
980
|
# The default is a 30-minute window selected at random from an 8-hour
|
984
|
-
# block of time for each
|
981
|
+
# block of time for each Region, occurring on a random day of the
|
985
982
|
# week.
|
986
983
|
#
|
987
984
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
@@ -990,10 +987,11 @@ module Aws::DocDB
|
|
990
987
|
# @return [String]
|
991
988
|
#
|
992
989
|
# @!attribute [rw] auto_minor_version_upgrade
|
993
|
-
#
|
994
|
-
#
|
990
|
+
# This parameter does not apply to Amazon DocumentDB. Amazon
|
991
|
+
# DocumentDB does not perform minor version upgrades regardless of the
|
992
|
+
# value set.
|
995
993
|
#
|
996
|
-
# Default: `
|
994
|
+
# Default: `false`
|
997
995
|
# @return [Boolean]
|
998
996
|
#
|
999
997
|
# @!attribute [rw] tags
|
@@ -1144,7 +1142,7 @@ module Aws::DocDB
|
|
1144
1142
|
# specified, all events are returned.
|
1145
1143
|
#
|
1146
1144
|
# Valid values: `db-instance`, `db-cluster`, `db-parameter-group`,
|
1147
|
-
# `db-security-group`, `db-
|
1145
|
+
# `db-security-group`, `db-cluster-snapshot`
|
1148
1146
|
# @return [String]
|
1149
1147
|
#
|
1150
1148
|
# @!attribute [rw] event_categories
|
@@ -1413,14 +1411,14 @@ module Aws::DocDB
|
|
1413
1411
|
# @return [Boolean]
|
1414
1412
|
#
|
1415
1413
|
# @!attribute [rw] kms_key_id
|
1416
|
-
# If `StorageEncrypted` is `true`, the
|
1414
|
+
# If `StorageEncrypted` is `true`, the KMS key identifier for the
|
1417
1415
|
# encrypted cluster.
|
1418
1416
|
# @return [String]
|
1419
1417
|
#
|
1420
1418
|
# @!attribute [rw] db_cluster_resource_id
|
1421
|
-
# The
|
1422
|
-
# identifier is found in
|
1423
|
-
#
|
1419
|
+
# The Region-unique, immutable identifier for the cluster. This
|
1420
|
+
# identifier is found in CloudTrail log entries whenever the KMS key
|
1421
|
+
# for the cluster is accessed.
|
1424
1422
|
# @return [String]
|
1425
1423
|
#
|
1426
1424
|
# @!attribute [rw] db_cluster_arn
|
@@ -1428,10 +1426,10 @@ module Aws::DocDB
|
|
1428
1426
|
# @return [String]
|
1429
1427
|
#
|
1430
1428
|
# @!attribute [rw] associated_roles
|
1431
|
-
# Provides a list of the
|
1432
|
-
#
|
1429
|
+
# Provides a list of the Identity and Access Management (IAM) roles
|
1430
|
+
# that are associated with the cluster. (IAM) roles that are
|
1433
1431
|
# associated with a cluster grant permission for the cluster to access
|
1434
|
-
# other
|
1432
|
+
# other Amazon Web Services services on your behalf.
|
1435
1433
|
# @return [Array<Types::DBClusterRole>]
|
1436
1434
|
#
|
1437
1435
|
# @!attribute [rw] cluster_create_time
|
@@ -1669,27 +1667,27 @@ module Aws::DocDB
|
|
1669
1667
|
#
|
1670
1668
|
class DBClusterQuotaExceededFault < Aws::EmptyStructure; end
|
1671
1669
|
|
1672
|
-
# Describes an
|
1670
|
+
# Describes an Identity and Access Management (IAM) role that is
|
1673
1671
|
# associated with a cluster.
|
1674
1672
|
#
|
1675
1673
|
# @!attribute [rw] role_arn
|
1676
|
-
# The Amazon Resource Name (ARN) of the
|
1674
|
+
# The Amazon Resource Name (ARN) of the IAMrole that is associated
|
1677
1675
|
# with the DB cluster.
|
1678
1676
|
# @return [String]
|
1679
1677
|
#
|
1680
1678
|
# @!attribute [rw] status
|
1681
|
-
# Describes the state of association between the
|
1679
|
+
# Describes the state of association between the IAMrole and the
|
1682
1680
|
# cluster. The `Status` property returns one of the following values:
|
1683
1681
|
#
|
1684
|
-
# * `ACTIVE` - The
|
1685
|
-
# be used to access other
|
1682
|
+
# * `ACTIVE` - The IAMrole ARN is associated with the cluster and can
|
1683
|
+
# be used to access other Amazon Web Services services on your
|
1684
|
+
# behalf.
|
1686
1685
|
#
|
1687
|
-
# * `PENDING` - The
|
1688
|
-
# cluster.
|
1686
|
+
# * `PENDING` - The IAMrole ARN is being associated with the cluster.
|
1689
1687
|
#
|
1690
|
-
# * `INVALID` - The
|
1691
|
-
# the cluster cannot assume the
|
1692
|
-
# services on your behalf.
|
1688
|
+
# * `INVALID` - The IAMrole ARN is associated with the cluster, but
|
1689
|
+
# the cluster cannot assume the IAMrole to access other Amazon Web
|
1690
|
+
# Services services on your behalf.
|
1693
1691
|
# @return [String]
|
1694
1692
|
#
|
1695
1693
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterRole AWS API Documentation
|
@@ -1767,7 +1765,7 @@ module Aws::DocDB
|
|
1767
1765
|
# @return [Boolean]
|
1768
1766
|
#
|
1769
1767
|
# @!attribute [rw] kms_key_id
|
1770
|
-
# If `StorageEncrypted` is `true`, the
|
1768
|
+
# If `StorageEncrypted` is `true`, the KMS key identifier for the
|
1771
1769
|
# encrypted cluster snapshot.
|
1772
1770
|
# @return [String]
|
1773
1771
|
#
|
@@ -1812,24 +1810,24 @@ module Aws::DocDB
|
|
1812
1810
|
|
1813
1811
|
# Contains the name and values of a manual cluster snapshot attribute.
|
1814
1812
|
#
|
1815
|
-
# Manual cluster snapshot attributes are used to authorize other
|
1813
|
+
# Manual cluster snapshot attributes are used to authorize other
|
1816
1814
|
# accounts to restore a manual cluster snapshot.
|
1817
1815
|
#
|
1818
1816
|
# @!attribute [rw] attribute_name
|
1819
1817
|
# The name of the manual cluster snapshot attribute.
|
1820
1818
|
#
|
1821
|
-
# The attribute named `restore` refers to the list of
|
1822
|
-
#
|
1819
|
+
# The attribute named `restore` refers to the list of accounts that
|
1820
|
+
# have permission to copy or restore the manual cluster snapshot.
|
1823
1821
|
# @return [String]
|
1824
1822
|
#
|
1825
1823
|
# @!attribute [rw] attribute_values
|
1826
1824
|
# The values for the manual cluster snapshot attribute.
|
1827
1825
|
#
|
1828
1826
|
# If the `AttributeName` field is set to `restore`, then this element
|
1829
|
-
# returns a list of IDs of the
|
1830
|
-
#
|
1831
|
-
#
|
1832
|
-
#
|
1827
|
+
# returns a list of IDs of the accounts that are authorized to copy or
|
1828
|
+
# restore the manual cluster snapshot. If a value of `all` is in the
|
1829
|
+
# list, then the manual cluster snapshot is public and available for
|
1830
|
+
# any account to copy or restore.
|
1833
1831
|
# @return [Array<String>]
|
1834
1832
|
#
|
1835
1833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttribute AWS API Documentation
|
@@ -2039,7 +2037,9 @@ module Aws::DocDB
|
|
2039
2037
|
# @return [String]
|
2040
2038
|
#
|
2041
2039
|
# @!attribute [rw] auto_minor_version_upgrade
|
2042
|
-
#
|
2040
|
+
# Does not apply. This parameter does not apply to Amazon DocumentDB.
|
2041
|
+
# Amazon DocumentDB does not perform minor version upgrades regardless
|
2042
|
+
# of the value set.
|
2043
2043
|
# @return [Boolean]
|
2044
2044
|
#
|
2045
2045
|
# @!attribute [rw] publicly_accessible
|
@@ -2062,14 +2062,14 @@ module Aws::DocDB
|
|
2062
2062
|
# @return [Boolean]
|
2063
2063
|
#
|
2064
2064
|
# @!attribute [rw] kms_key_id
|
2065
|
-
# If `StorageEncrypted` is `true`, the
|
2065
|
+
# If `StorageEncrypted` is `true`, the KMS key identifier for the
|
2066
2066
|
# encrypted instance.
|
2067
2067
|
# @return [String]
|
2068
2068
|
#
|
2069
2069
|
# @!attribute [rw] dbi_resource_id
|
2070
|
-
# The
|
2071
|
-
# identifier is found in
|
2072
|
-
#
|
2070
|
+
# The Region-unique, immutable identifier for the instance. This
|
2071
|
+
# identifier is found in CloudTrail log entries whenever the KMS key
|
2072
|
+
# for the instance is accessed.
|
2073
2073
|
# @return [String]
|
2074
2074
|
#
|
2075
2075
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -2088,7 +2088,7 @@ module Aws::DocDB
|
|
2088
2088
|
#
|
2089
2089
|
# @!attribute [rw] enabled_cloudwatch_logs_exports
|
2090
2090
|
# A list of log types that this instance is configured to export to
|
2091
|
-
#
|
2091
|
+
# CloudWatch Logs.
|
2092
2092
|
# @return [Array<String>]
|
2093
2093
|
#
|
2094
2094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstance AWS API Documentation
|
@@ -2888,13 +2888,13 @@ module Aws::DocDB
|
|
2888
2888
|
# the following values:
|
2889
2889
|
#
|
2890
2890
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2891
|
-
# has automatically created for your
|
2891
|
+
# has automatically created for your account.
|
2892
2892
|
#
|
2893
2893
|
# * `manual` - Return all cluster snapshots that you have manually
|
2894
|
-
# created for your
|
2894
|
+
# created for your account.
|
2895
2895
|
#
|
2896
2896
|
# * `shared` - Return all manual cluster snapshots that have been
|
2897
|
-
# shared to your
|
2897
|
+
# shared to your account.
|
2898
2898
|
#
|
2899
2899
|
# * `public` - Return all cluster snapshots that have been marked as
|
2900
2900
|
# public.
|
@@ -2935,14 +2935,14 @@ module Aws::DocDB
|
|
2935
2935
|
#
|
2936
2936
|
# @!attribute [rw] include_shared
|
2937
2937
|
# Set to `true` to include shared manual cluster snapshots from other
|
2938
|
-
#
|
2939
|
-
#
|
2938
|
+
# accounts that this account has been given permission to copy or
|
2939
|
+
# restore, and otherwise `false`. The default is `false`.
|
2940
2940
|
# @return [Boolean]
|
2941
2941
|
#
|
2942
2942
|
# @!attribute [rw] include_public
|
2943
2943
|
# Set to `true` to include manual cluster snapshots that are public
|
2944
|
-
# and can be copied or restored by any
|
2945
|
-
#
|
2944
|
+
# and can be copied or restored by any account, and otherwise `false`.
|
2945
|
+
# The default is `false`.
|
2946
2946
|
# @return [Boolean]
|
2947
2947
|
#
|
2948
2948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotsMessage AWS API Documentation
|
@@ -3337,7 +3337,7 @@ module Aws::DocDB
|
|
3337
3337
|
# The type of source that is generating the events.
|
3338
3338
|
#
|
3339
3339
|
# Valid values: `db-instance`, `db-parameter-group`,
|
3340
|
-
# `db-security-group
|
3340
|
+
# `db-security-group`
|
3341
3341
|
# @return [String]
|
3342
3342
|
#
|
3343
3343
|
# @!attribute [rw] filters
|
@@ -3849,8 +3849,8 @@ module Aws::DocDB
|
|
3849
3849
|
# Detailed information about an event to which you have subscribed.
|
3850
3850
|
#
|
3851
3851
|
# @!attribute [rw] customer_aws_id
|
3852
|
-
# The
|
3853
|
-
# DocumentDB event notification subscription.
|
3852
|
+
# The Amazon Web Services customer account that is associated with the
|
3853
|
+
# Amazon DocumentDB event notification subscription.
|
3854
3854
|
# @return [String]
|
3855
3855
|
#
|
3856
3856
|
# @!attribute [rw] cust_subscription_id
|
@@ -4058,7 +4058,7 @@ module Aws::DocDB
|
|
4058
4058
|
# @return [String]
|
4059
4059
|
#
|
4060
4060
|
# @!attribute [rw] global_cluster_resource_id
|
4061
|
-
# The
|
4061
|
+
# The Region-unique, immutable identifier for the global database
|
4062
4062
|
# cluster. This identifier is found in AWS CloudTrail log entries
|
4063
4063
|
# whenever the AWS KMS customer master key (CMK) for the cluster is
|
4064
4064
|
# accessed.
|
@@ -4290,7 +4290,7 @@ module Aws::DocDB
|
|
4290
4290
|
#
|
4291
4291
|
class InvalidVPCNetworkStateFault < Aws::EmptyStructure; end
|
4292
4292
|
|
4293
|
-
# An error occurred when accessing an
|
4293
|
+
# An error occurred when accessing an KMS key.
|
4294
4294
|
#
|
4295
4295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/KMSKeyNotAccessibleFault AWS API Documentation
|
4296
4296
|
#
|
@@ -4441,7 +4441,7 @@ module Aws::DocDB
|
|
4441
4441
|
# parameter.
|
4442
4442
|
#
|
4443
4443
|
# The default is a 30-minute window selected at random from an 8-hour
|
4444
|
-
# block of time for each
|
4444
|
+
# block of time for each Region.
|
4445
4445
|
#
|
4446
4446
|
# Constraints:
|
4447
4447
|
#
|
@@ -4461,7 +4461,7 @@ module Aws::DocDB
|
|
4461
4461
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
4462
4462
|
#
|
4463
4463
|
# The default is a 30-minute window selected at random from an 8-hour
|
4464
|
-
# block of time for each
|
4464
|
+
# block of time for each Region, occurring on a random day of the
|
4465
4465
|
# week.
|
4466
4466
|
#
|
4467
4467
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
@@ -4582,7 +4582,7 @@ module Aws::DocDB
|
|
4582
4582
|
# @!attribute [rw] attribute_name
|
4583
4583
|
# The name of the cluster snapshot attribute to modify.
|
4584
4584
|
#
|
4585
|
-
# To manage authorization for other
|
4585
|
+
# To manage authorization for other accounts to copy or restore a
|
4586
4586
|
# manual cluster snapshot, set this value to `restore`.
|
4587
4587
|
# @return [String]
|
4588
4588
|
#
|
@@ -4590,25 +4590,25 @@ module Aws::DocDB
|
|
4590
4590
|
# A list of cluster snapshot attributes to add to the attribute
|
4591
4591
|
# specified by `AttributeName`.
|
4592
4592
|
#
|
4593
|
-
# To authorize other
|
4594
|
-
# snapshot, set this list to include one or more
|
4595
|
-
#
|
4596
|
-
#
|
4597
|
-
#
|
4598
|
-
#
|
4593
|
+
# To authorize other accounts to copy or restore a manual cluster
|
4594
|
+
# snapshot, set this list to include one or more account IDs. To make
|
4595
|
+
# the manual cluster snapshot restorable by any account, set it to
|
4596
|
+
# `all`. Do not add the `all` value for any manual cluster snapshots
|
4597
|
+
# that contain private information that you don't want to be
|
4598
|
+
# available to all accounts.
|
4599
4599
|
# @return [Array<String>]
|
4600
4600
|
#
|
4601
4601
|
# @!attribute [rw] values_to_remove
|
4602
4602
|
# A list of cluster snapshot attributes to remove from the attribute
|
4603
4603
|
# specified by `AttributeName`.
|
4604
4604
|
#
|
4605
|
-
# To remove authorization for other
|
4606
|
-
# manual cluster snapshot, set this list to include one or more
|
4607
|
-
# account identifiers. To remove authorization for any
|
4608
|
-
#
|
4609
|
-
#
|
4610
|
-
#
|
4611
|
-
#
|
4605
|
+
# To remove authorization for other accounts to copy or restore a
|
4606
|
+
# manual cluster snapshot, set this list to include one or more
|
4607
|
+
# account identifiers. To remove authorization for any account to copy
|
4608
|
+
# or restore the cluster snapshot, set it to `all` . If you specify
|
4609
|
+
# `all`, an account whose account ID is explicitly added to the
|
4610
|
+
# `restore` attribute can still copy or restore a manual cluster
|
4611
|
+
# snapshot.
|
4612
4612
|
# @return [Array<String>]
|
4613
4613
|
#
|
4614
4614
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttributeMessage AWS API Documentation
|
@@ -4663,7 +4663,7 @@ module Aws::DocDB
|
|
4663
4663
|
#
|
4664
4664
|
# @!attribute [rw] db_instance_class
|
4665
4665
|
# The new compute and memory capacity of the instance; for example,
|
4666
|
-
# `db.r5.large`. Not all instance classes are available in all
|
4666
|
+
# `db.r5.large`. Not all instance classes are available in all
|
4667
4667
|
# Regions.
|
4668
4668
|
#
|
4669
4669
|
# If you modify the instance class, an outage occurs during the
|
@@ -4708,13 +4708,9 @@ module Aws::DocDB
|
|
4708
4708
|
# @return [String]
|
4709
4709
|
#
|
4710
4710
|
# @!attribute [rw] auto_minor_version_upgrade
|
4711
|
-
#
|
4712
|
-
#
|
4713
|
-
#
|
4714
|
-
# change is asynchronously applied as soon as possible. An outage
|
4715
|
-
# results if this parameter is set to `true` during the maintenance
|
4716
|
-
# window, and a newer minor version is available, and Amazon
|
4717
|
-
# DocumentDB has enabled automatic patching for that engine version.
|
4711
|
+
# This parameter does not apply to Amazon DocumentDB. Amazon
|
4712
|
+
# DocumentDB does not perform minor version upgrades regardless of the
|
4713
|
+
# value set.
|
4718
4714
|
# @return [Boolean]
|
4719
4715
|
#
|
4720
4716
|
# @!attribute [rw] new_db_instance_identifier
|
@@ -4858,7 +4854,7 @@ module Aws::DocDB
|
|
4858
4854
|
# events are returned.
|
4859
4855
|
#
|
4860
4856
|
# Valid values: `db-instance`, `db-parameter-group`,
|
4861
|
-
# `db-security-group
|
4857
|
+
# `db-security-group`
|
4862
4858
|
# @return [String]
|
4863
4859
|
#
|
4864
4860
|
# @!attribute [rw] event_categories
|
@@ -5615,22 +5611,21 @@ module Aws::DocDB
|
|
5615
5611
|
# @return [Array<Types::Tag>]
|
5616
5612
|
#
|
5617
5613
|
# @!attribute [rw] kms_key_id
|
5618
|
-
# The
|
5619
|
-
#
|
5614
|
+
# The KMS key identifier to use when restoring an encrypted cluster
|
5615
|
+
# from a DB snapshot or cluster snapshot.
|
5620
5616
|
#
|
5621
|
-
# The
|
5622
|
-
#
|
5623
|
-
#
|
5624
|
-
#
|
5625
|
-
#
|
5617
|
+
# 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 account
|
5619
|
+
# that owns the KMS encryption key used to encrypt the new cluster,
|
5620
|
+
# then you can use the KMS key alias instead of the ARN for the KMS
|
5621
|
+
# encryption key.
|
5626
5622
|
#
|
5627
5623
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
5628
5624
|
# following occurs:
|
5629
5625
|
#
|
5630
5626
|
# * If the snapshot or cluster snapshot in `SnapshotIdentifier` is
|
5631
|
-
# encrypted, then the restored cluster is encrypted using the
|
5632
|
-
#
|
5633
|
-
# snapshot.
|
5627
|
+
# encrypted, then the restored cluster is encrypted using the KMS
|
5628
|
+
# key that was used to encrypt the snapshot or the cluster snapshot.
|
5634
5629
|
#
|
5635
5630
|
# * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is
|
5636
5631
|
# not encrypted, then the restored DB cluster is not encrypted.
|
@@ -5783,26 +5778,26 @@ module Aws::DocDB
|
|
5783
5778
|
# @return [Array<Types::Tag>]
|
5784
5779
|
#
|
5785
5780
|
# @!attribute [rw] kms_key_id
|
5786
|
-
# The
|
5787
|
-
#
|
5781
|
+
# The KMS key identifier to use when restoring an encrypted cluster
|
5782
|
+
# from an encrypted cluster.
|
5788
5783
|
#
|
5789
|
-
# The
|
5790
|
-
#
|
5791
|
-
#
|
5792
|
-
#
|
5793
|
-
#
|
5784
|
+
# 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 account
|
5786
|
+
# that owns the KMS encryption key used to encrypt the new cluster,
|
5787
|
+
# then you can use the KMS key alias instead of the ARN for the KMS
|
5788
|
+
# encryption key.
|
5794
5789
|
#
|
5795
5790
|
# You can restore to a new cluster and encrypt the new cluster with an
|
5796
|
-
#
|
5797
|
-
#
|
5798
|
-
#
|
5791
|
+
# KMS key that is different from the KMS key used to encrypt the
|
5792
|
+
# source cluster. The new DB cluster is encrypted with the KMS key
|
5793
|
+
# identified by the `KmsKeyId` parameter.
|
5799
5794
|
#
|
5800
5795
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
5801
5796
|
# following occurs:
|
5802
5797
|
#
|
5803
5798
|
# * If the cluster is encrypted, then the restored cluster is
|
5804
|
-
# encrypted using the
|
5805
|
-
#
|
5799
|
+
# encrypted using the KMS key that was used to encrypt the source
|
5800
|
+
# cluster.
|
5806
5801
|
#
|
5807
5802
|
# * If the cluster is not encrypted, then the restored cluster is not
|
5808
5803
|
# encrypted.
|
@@ -6032,19 +6027,19 @@ module Aws::DocDB
|
|
6032
6027
|
#
|
6033
6028
|
# @!attribute [rw] key
|
6034
6029
|
# The required name of the tag. The string value can be from 1 to 128
|
6035
|
-
# Unicode characters in length and can't be prefixed with "aws
|
6036
|
-
# "rds
|
6037
|
-
# digits, white space, '\_', '.', '/', '=', '+',
|
6038
|
-
# regex:
|
6030
|
+
# Unicode characters in length and can't be prefixed with "`aws:`"
|
6031
|
+
# or "`rds:`". The string can contain only the set of Unicode
|
6032
|
+
# letters, digits, white space, '\_', '.', '/', '=', '+',
|
6033
|
+
# '-' (Java regex:
|
6039
6034
|
# "^(\[\\\\p\\\{L\\}\\\\p\\\{Z\\}\\\\p\\\{N\\}\_.:/=+\\\\-\]*)$").
|
6040
6035
|
# @return [String]
|
6041
6036
|
#
|
6042
6037
|
# @!attribute [rw] value
|
6043
6038
|
# The optional value of the tag. The string value can be from 1 to 256
|
6044
|
-
# Unicode characters in length and can't be prefixed with "aws
|
6045
|
-
# "rds
|
6046
|
-
# digits, white space, '\_', '.', '/', '=', '+',
|
6047
|
-
# regex:
|
6039
|
+
# Unicode characters in length and can't be prefixed with "`aws:`"
|
6040
|
+
# or "`rds:`". The string can contain only the set of Unicode
|
6041
|
+
# letters, digits, white space, '\_', '.', '/', '=', '+',
|
6042
|
+
# '-' (Java regex:
|
6048
6043
|
# "^(\[\\\\p\\\{L\\}\\\\p\\\{Z\\}\\\\p\\\{N\\}\_.:/=+\\\\-\]*)$").
|
6049
6044
|
# @return [String]
|
6050
6045
|
#
|
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.35.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: 2021-
|
11
|
+
date: 2021-09-01 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.120.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.120.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -78,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
78
78
|
requirements:
|
79
79
|
- - ">="
|
80
80
|
- !ruby/object:Gem::Version
|
81
|
-
version: '
|
81
|
+
version: '2.3'
|
82
82
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
83
83
|
requirements:
|
84
84
|
- - ">="
|