aws-sdk-docdb 1.41.0 → 1.44.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-docdb/client.rb +205 -98
- data/lib/aws-sdk-docdb/client_api.rb +9 -0
- data/lib/aws-sdk-docdb/types.rb +210 -100
- data/lib/aws-sdk-docdb.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-docdb/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
|
@@ -933,7 +942,10 @@ module Aws::DocDB
|
|
933
942
|
# },
|
934
943
|
# ],
|
935
944
|
# db_cluster_identifier: "String", # required
|
945
|
+
# copy_tags_to_snapshot: false,
|
936
946
|
# promotion_tier: 1,
|
947
|
+
# enable_performance_insights: false,
|
948
|
+
# performance_insights_kms_key_id: "String",
|
937
949
|
# }
|
938
950
|
#
|
939
951
|
# @!attribute [rw] db_instance_identifier
|
@@ -966,7 +978,7 @@ module Aws::DocDB
|
|
966
978
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
967
979
|
#
|
968
980
|
# Default: A random, system-chosen Availability Zone in the
|
969
|
-
# endpoint's Region.
|
981
|
+
# endpoint's Amazon Web Services Region.
|
970
982
|
#
|
971
983
|
# Example: `us-east-1d`
|
972
984
|
# @return [String]
|
@@ -978,8 +990,8 @@ module Aws::DocDB
|
|
978
990
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
979
991
|
#
|
980
992
|
# 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.
|
993
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
994
|
+
# random day of the week.
|
983
995
|
#
|
984
996
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
985
997
|
#
|
@@ -1003,6 +1015,11 @@ module Aws::DocDB
|
|
1003
1015
|
# The identifier of the cluster that the instance will belong to.
|
1004
1016
|
# @return [String]
|
1005
1017
|
#
|
1018
|
+
# @!attribute [rw] copy_tags_to_snapshot
|
1019
|
+
# A value that indicates whether to copy tags from the DB instance to
|
1020
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
1021
|
+
# @return [Boolean]
|
1022
|
+
#
|
1006
1023
|
# @!attribute [rw] promotion_tier
|
1007
1024
|
# A value that specifies the order in which an Amazon DocumentDB
|
1008
1025
|
# replica is promoted to the primary instance after a failure of the
|
@@ -1013,6 +1030,29 @@ module Aws::DocDB
|
|
1013
1030
|
# Valid values: 0-15
|
1014
1031
|
# @return [Integer]
|
1015
1032
|
#
|
1033
|
+
# @!attribute [rw] enable_performance_insights
|
1034
|
+
# A value that indicates whether to enable Performance Insights for
|
1035
|
+
# the DB Instance. For more information, see [Using Amazon Performance
|
1036
|
+
# Insights][1].
|
1037
|
+
#
|
1038
|
+
#
|
1039
|
+
#
|
1040
|
+
# [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html
|
1041
|
+
# @return [Boolean]
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] performance_insights_kms_key_id
|
1044
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
1045
|
+
#
|
1046
|
+
# The KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1047
|
+
# name for the KMS key.
|
1048
|
+
#
|
1049
|
+
# If you do not specify a value for PerformanceInsightsKMSKeyId, then
|
1050
|
+
# Amazon DocumentDB uses your default KMS key. There is a default KMS
|
1051
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
1052
|
+
# account has a different default KMS key for each Amazon Web Services
|
1053
|
+
# region.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1016
1056
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstanceMessage AWS API Documentation
|
1017
1057
|
#
|
1018
1058
|
class CreateDBInstanceMessage < Struct.new(
|
@@ -1024,7 +1064,10 @@ module Aws::DocDB
|
|
1024
1064
|
:auto_minor_version_upgrade,
|
1025
1065
|
:tags,
|
1026
1066
|
:db_cluster_identifier,
|
1027
|
-
:
|
1067
|
+
:copy_tags_to_snapshot,
|
1068
|
+
:promotion_tier,
|
1069
|
+
:enable_performance_insights,
|
1070
|
+
:performance_insights_kms_key_id)
|
1028
1071
|
SENSITIVE = []
|
1029
1072
|
include Aws::Structure
|
1030
1073
|
end
|
@@ -1416,9 +1459,9 @@ module Aws::DocDB
|
|
1416
1459
|
# @return [String]
|
1417
1460
|
#
|
1418
1461
|
# @!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.
|
1462
|
+
# The Amazon Web Services Region-unique, immutable identifier for the
|
1463
|
+
# cluster. This identifier is found in CloudTrail log entries whenever
|
1464
|
+
# the KMS key for the cluster is accessed.
|
1422
1465
|
# @return [String]
|
1423
1466
|
#
|
1424
1467
|
# @!attribute [rw] db_cluster_arn
|
@@ -1432,6 +1475,10 @@ module Aws::DocDB
|
|
1432
1475
|
# other Amazon Web Services services on your behalf.
|
1433
1476
|
# @return [Array<Types::DBClusterRole>]
|
1434
1477
|
#
|
1478
|
+
# @!attribute [rw] clone_group_id
|
1479
|
+
# Identifies the clone group to which the DB cluster is associated.
|
1480
|
+
# @return [String]
|
1481
|
+
#
|
1435
1482
|
# @!attribute [rw] cluster_create_time
|
1436
1483
|
# Specifies the time when the cluster was created, in Universal
|
1437
1484
|
# Coordinated Time (UTC).
|
@@ -1481,6 +1528,7 @@ module Aws::DocDB
|
|
1481
1528
|
:db_cluster_resource_id,
|
1482
1529
|
:db_cluster_arn,
|
1483
1530
|
:associated_roles,
|
1531
|
+
:clone_group_id,
|
1484
1532
|
:cluster_create_time,
|
1485
1533
|
:enabled_cloudwatch_logs_exports,
|
1486
1534
|
:deletion_protection)
|
@@ -1810,24 +1858,26 @@ module Aws::DocDB
|
|
1810
1858
|
|
1811
1859
|
# Contains the name and values of a manual cluster snapshot attribute.
|
1812
1860
|
#
|
1813
|
-
# Manual cluster snapshot attributes are used to authorize other
|
1814
|
-
# accounts to restore a manual cluster snapshot.
|
1861
|
+
# Manual cluster snapshot attributes are used to authorize other Amazon
|
1862
|
+
# Web Services accounts to restore a manual cluster snapshot.
|
1815
1863
|
#
|
1816
1864
|
# @!attribute [rw] attribute_name
|
1817
1865
|
# The name of the manual cluster snapshot attribute.
|
1818
1866
|
#
|
1819
|
-
# The attribute named `restore` refers to the list of
|
1820
|
-
# have permission to copy or restore the manual
|
1867
|
+
# The attribute named `restore` refers to the list of Amazon Web
|
1868
|
+
# Services accounts that have permission to copy or restore the manual
|
1869
|
+
# cluster snapshot.
|
1821
1870
|
# @return [String]
|
1822
1871
|
#
|
1823
1872
|
# @!attribute [rw] attribute_values
|
1824
1873
|
# The values for the manual cluster snapshot attribute.
|
1825
1874
|
#
|
1826
1875
|
# 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
|
1876
|
+
# returns a list of IDs of the Amazon Web Services accounts that are
|
1877
|
+
# authorized to copy or restore the manual cluster snapshot. If a
|
1878
|
+
# value of `all` is in the list, then the manual cluster snapshot is
|
1879
|
+
# public and available for any Amazon Web Services account to copy or
|
1880
|
+
# restore.
|
1831
1881
|
# @return [Array<String>]
|
1832
1882
|
#
|
1833
1883
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttribute AWS API Documentation
|
@@ -2067,15 +2117,20 @@ module Aws::DocDB
|
|
2067
2117
|
# @return [String]
|
2068
2118
|
#
|
2069
2119
|
# @!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.
|
2120
|
+
# The Amazon Web Services Region-unique, immutable identifier for the
|
2121
|
+
# instance. This identifier is found in CloudTrail log entries
|
2122
|
+
# whenever the KMS key for the instance is accessed.
|
2073
2123
|
# @return [String]
|
2074
2124
|
#
|
2075
2125
|
# @!attribute [rw] ca_certificate_identifier
|
2076
2126
|
# The identifier of the CA certificate for this DB instance.
|
2077
2127
|
# @return [String]
|
2078
2128
|
#
|
2129
|
+
# @!attribute [rw] copy_tags_to_snapshot
|
2130
|
+
# A value that indicates whether to copy tags from the DB instance to
|
2131
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
2132
|
+
# @return [Boolean]
|
2133
|
+
#
|
2079
2134
|
# @!attribute [rw] promotion_tier
|
2080
2135
|
# A value that specifies the order in which an Amazon DocumentDB
|
2081
2136
|
# replica is promoted to the primary instance after a failure of the
|
@@ -2117,6 +2172,7 @@ module Aws::DocDB
|
|
2117
2172
|
:kms_key_id,
|
2118
2173
|
:dbi_resource_id,
|
2119
2174
|
:ca_certificate_identifier,
|
2175
|
+
:copy_tags_to_snapshot,
|
2120
2176
|
:promotion_tier,
|
2121
2177
|
:db_instance_arn,
|
2122
2178
|
:enabled_cloudwatch_logs_exports)
|
@@ -2888,13 +2944,13 @@ module Aws::DocDB
|
|
2888
2944
|
# the following values:
|
2889
2945
|
#
|
2890
2946
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2891
|
-
# has automatically created for your account.
|
2947
|
+
# has automatically created for your Amazon Web Services account.
|
2892
2948
|
#
|
2893
2949
|
# * `manual` - Return all cluster snapshots that you have manually
|
2894
|
-
# created for your account.
|
2950
|
+
# created for your Amazon Web Services account.
|
2895
2951
|
#
|
2896
2952
|
# * `shared` - Return all manual cluster snapshots that have been
|
2897
|
-
# shared to your account.
|
2953
|
+
# shared to your Amazon Web Services account.
|
2898
2954
|
#
|
2899
2955
|
# * `public` - Return all cluster snapshots that have been marked as
|
2900
2956
|
# public.
|
@@ -2935,14 +2991,15 @@ module Aws::DocDB
|
|
2935
2991
|
#
|
2936
2992
|
# @!attribute [rw] include_shared
|
2937
2993
|
# Set to `true` to include shared manual cluster snapshots from other
|
2938
|
-
# accounts that this
|
2939
|
-
# restore, and otherwise `false`.
|
2994
|
+
# Amazon Web Services accounts that this Amazon Web Services account
|
2995
|
+
# has been given permission to copy or restore, and otherwise `false`.
|
2996
|
+
# The default is `false`.
|
2940
2997
|
# @return [Boolean]
|
2941
2998
|
#
|
2942
2999
|
# @!attribute [rw] include_public
|
2943
3000
|
# 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`.
|
3001
|
+
# and can be copied or restored by any Amazon Web Services account,
|
3002
|
+
# and otherwise `false`. The default is `false`.
|
2946
3003
|
# @return [Boolean]
|
2947
3004
|
#
|
2948
3005
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotsMessage AWS API Documentation
|
@@ -4058,10 +4115,10 @@ module Aws::DocDB
|
|
4058
4115
|
# @return [String]
|
4059
4116
|
#
|
4060
4117
|
# @!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.
|
4118
|
+
# The Amazon Web Services Region-unique, immutable identifier for the
|
4119
|
+
# global database cluster. This identifier is found in AWS CloudTrail
|
4120
|
+
# log entries whenever the AWS KMS customer master key (CMK) for the
|
4121
|
+
# cluster is accessed.
|
4065
4122
|
# @return [String]
|
4066
4123
|
#
|
4067
4124
|
# @!attribute [rw] global_cluster_arn
|
@@ -4441,7 +4498,7 @@ module Aws::DocDB
|
|
4441
4498
|
# parameter.
|
4442
4499
|
#
|
4443
4500
|
# The default is a 30-minute window selected at random from an 8-hour
|
4444
|
-
# block of time for each Region.
|
4501
|
+
# block of time for each Amazon Web Services Region.
|
4445
4502
|
#
|
4446
4503
|
# Constraints:
|
4447
4504
|
#
|
@@ -4461,8 +4518,8 @@ module Aws::DocDB
|
|
4461
4518
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
4462
4519
|
#
|
4463
4520
|
# 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.
|
4521
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
4522
|
+
# random day of the week.
|
4466
4523
|
#
|
4467
4524
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
4468
4525
|
#
|
@@ -4582,32 +4639,35 @@ module Aws::DocDB
|
|
4582
4639
|
# @!attribute [rw] attribute_name
|
4583
4640
|
# The name of the cluster snapshot attribute to modify.
|
4584
4641
|
#
|
4585
|
-
# To manage authorization for other
|
4586
|
-
# manual cluster snapshot, set this value to
|
4642
|
+
# To manage authorization for other Amazon Web Services accounts to
|
4643
|
+
# copy or restore a manual cluster snapshot, set this value to
|
4644
|
+
# `restore`.
|
4587
4645
|
# @return [String]
|
4588
4646
|
#
|
4589
4647
|
# @!attribute [rw] values_to_add
|
4590
4648
|
# A list of cluster snapshot attributes to add to the attribute
|
4591
4649
|
# specified by `AttributeName`.
|
4592
4650
|
#
|
4593
|
-
# To authorize other accounts to copy or restore a
|
4594
|
-
# snapshot, set this list to include one or more
|
4595
|
-
#
|
4596
|
-
#
|
4597
|
-
#
|
4598
|
-
#
|
4651
|
+
# To authorize other Amazon Web Services accounts to copy or restore a
|
4652
|
+
# manual cluster snapshot, set this list to include one or more Amazon
|
4653
|
+
# Web Services account IDs. To make the manual cluster snapshot
|
4654
|
+
# restorable by any Amazon Web Services account, set it to `all`. Do
|
4655
|
+
# not add the `all` value for any manual cluster snapshots that
|
4656
|
+
# contain private information that you don't want to be available to
|
4657
|
+
# all Amazon Web Services accounts.
|
4599
4658
|
# @return [Array<String>]
|
4600
4659
|
#
|
4601
4660
|
# @!attribute [rw] values_to_remove
|
4602
4661
|
# A list of cluster snapshot attributes to remove from the attribute
|
4603
4662
|
# specified by `AttributeName`.
|
4604
4663
|
#
|
4605
|
-
# To remove authorization for other
|
4606
|
-
# manual cluster snapshot, set this list to include
|
4607
|
-
#
|
4608
|
-
#
|
4609
|
-
#
|
4610
|
-
#
|
4664
|
+
# To remove authorization for other Amazon Web Services accounts to
|
4665
|
+
# copy or restore a manual cluster snapshot, set this list to include
|
4666
|
+
# one or more Amazon Web Services account identifiers. To remove
|
4667
|
+
# authorization for any Amazon Web Services account to copy or restore
|
4668
|
+
# the cluster snapshot, set it to `all` . If you specify `all`, an
|
4669
|
+
# Amazon Web Services account whose account ID is explicitly added to
|
4670
|
+
# the `restore` attribute can still copy or restore a manual cluster
|
4611
4671
|
# snapshot.
|
4612
4672
|
# @return [Array<String>]
|
4613
4673
|
#
|
@@ -4648,7 +4708,10 @@ module Aws::DocDB
|
|
4648
4708
|
# auto_minor_version_upgrade: false,
|
4649
4709
|
# new_db_instance_identifier: "String",
|
4650
4710
|
# ca_certificate_identifier: "String",
|
4711
|
+
# copy_tags_to_snapshot: false,
|
4651
4712
|
# promotion_tier: 1,
|
4713
|
+
# enable_performance_insights: false,
|
4714
|
+
# performance_insights_kms_key_id: "String",
|
4652
4715
|
# }
|
4653
4716
|
#
|
4654
4717
|
# @!attribute [rw] db_instance_identifier
|
@@ -4663,8 +4726,8 @@ module Aws::DocDB
|
|
4663
4726
|
#
|
4664
4727
|
# @!attribute [rw] db_instance_class
|
4665
4728
|
# 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.
|
4729
|
+
# `db.r5.large`. Not all instance classes are available in all Amazon
|
4730
|
+
# Web Services Regions.
|
4668
4731
|
#
|
4669
4732
|
# If you modify the instance class, an outage occurs during the
|
4670
4733
|
# change. The change is applied during the next maintenance window,
|
@@ -4736,6 +4799,11 @@ module Aws::DocDB
|
|
4736
4799
|
# instance.
|
4737
4800
|
# @return [String]
|
4738
4801
|
#
|
4802
|
+
# @!attribute [rw] copy_tags_to_snapshot
|
4803
|
+
# A value that indicates whether to copy all tags from the DB instance
|
4804
|
+
# to snapshots of the DB instance. By default, tags are not copied.
|
4805
|
+
# @return [Boolean]
|
4806
|
+
#
|
4739
4807
|
# @!attribute [rw] promotion_tier
|
4740
4808
|
# A value that specifies the order in which an Amazon DocumentDB
|
4741
4809
|
# replica is promoted to the primary instance after a failure of the
|
@@ -4746,6 +4814,29 @@ module Aws::DocDB
|
|
4746
4814
|
# Valid values: 0-15
|
4747
4815
|
# @return [Integer]
|
4748
4816
|
#
|
4817
|
+
# @!attribute [rw] enable_performance_insights
|
4818
|
+
# A value that indicates whether to enable Performance Insights for
|
4819
|
+
# the DB Instance. For more information, see [Using Amazon Performance
|
4820
|
+
# Insights][1].
|
4821
|
+
#
|
4822
|
+
#
|
4823
|
+
#
|
4824
|
+
# [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html
|
4825
|
+
# @return [Boolean]
|
4826
|
+
#
|
4827
|
+
# @!attribute [rw] performance_insights_kms_key_id
|
4828
|
+
# The KMS key identifier for encryption of Performance Insights data.
|
4829
|
+
#
|
4830
|
+
# The KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
4831
|
+
# name for the KMS key.
|
4832
|
+
#
|
4833
|
+
# If you do not specify a value for PerformanceInsightsKMSKeyId, then
|
4834
|
+
# Amazon DocumentDB uses your default KMS key. There is a default KMS
|
4835
|
+
# key for your Amazon Web Services account. Your Amazon Web Services
|
4836
|
+
# account has a different default KMS key for each Amazon Web Services
|
4837
|
+
# region.
|
4838
|
+
# @return [String]
|
4839
|
+
#
|
4749
4840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
|
4750
4841
|
#
|
4751
4842
|
class ModifyDBInstanceMessage < Struct.new(
|
@@ -4756,7 +4847,10 @@ module Aws::DocDB
|
|
4756
4847
|
:auto_minor_version_upgrade,
|
4757
4848
|
:new_db_instance_identifier,
|
4758
4849
|
:ca_certificate_identifier,
|
4759
|
-
:
|
4850
|
+
:copy_tags_to_snapshot,
|
4851
|
+
:promotion_tier,
|
4852
|
+
:enable_performance_insights,
|
4853
|
+
:performance_insights_kms_key_id)
|
4760
4854
|
SENSITIVE = []
|
4761
4855
|
include Aws::Structure
|
4762
4856
|
end
|
@@ -5615,10 +5709,10 @@ module Aws::DocDB
|
|
5615
5709
|
# from a DB snapshot or cluster snapshot.
|
5616
5710
|
#
|
5617
5711
|
# 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.
|
5712
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
5713
|
+
# Web Services account that owns the KMS encryption key used to
|
5714
|
+
# encrypt the new cluster, then you can use the KMS key alias instead
|
5715
|
+
# of the ARN for the KMS encryption key.
|
5622
5716
|
#
|
5623
5717
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
5624
5718
|
# following occurs:
|
@@ -5682,6 +5776,7 @@ module Aws::DocDB
|
|
5682
5776
|
#
|
5683
5777
|
# {
|
5684
5778
|
# db_cluster_identifier: "String", # required
|
5779
|
+
# restore_type: "String",
|
5685
5780
|
# source_db_cluster_identifier: "String", # required
|
5686
5781
|
# restore_to_time: Time.now,
|
5687
5782
|
# use_latest_restorable_time: false,
|
@@ -5711,6 +5806,20 @@ module Aws::DocDB
|
|
5711
5806
|
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
5712
5807
|
# @return [String]
|
5713
5808
|
#
|
5809
|
+
# @!attribute [rw] restore_type
|
5810
|
+
# The type of restore to be performed. You can specify one of the
|
5811
|
+
# following values:
|
5812
|
+
#
|
5813
|
+
# * `full-copy` - The new DB cluster is restored as a full copy of the
|
5814
|
+
# source DB cluster.
|
5815
|
+
#
|
5816
|
+
# * `copy-on-write` - The new DB cluster is restored as a clone of the
|
5817
|
+
# source DB cluster.
|
5818
|
+
#
|
5819
|
+
# If you don't specify a `RestoreType` value, then the new DB cluster
|
5820
|
+
# is restored as a full copy of the source DB cluster.
|
5821
|
+
# @return [String]
|
5822
|
+
#
|
5714
5823
|
# @!attribute [rw] source_db_cluster_identifier
|
5715
5824
|
# The identifier of the source cluster from which to restore.
|
5716
5825
|
#
|
@@ -5782,10 +5891,10 @@ module Aws::DocDB
|
|
5782
5891
|
# from an encrypted cluster.
|
5783
5892
|
#
|
5784
5893
|
# 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.
|
5894
|
+
# encryption key. If you are restoring a cluster with the same Amazon
|
5895
|
+
# Web Services account that owns the KMS encryption key used to
|
5896
|
+
# encrypt the new cluster, then you can use the KMS key alias instead
|
5897
|
+
# of the ARN for the KMS encryption key.
|
5789
5898
|
#
|
5790
5899
|
# You can restore to a new cluster and encrypt the new cluster with an
|
5791
5900
|
# KMS key that is different from the KMS key used to encrypt the
|
@@ -5823,6 +5932,7 @@ module Aws::DocDB
|
|
5823
5932
|
#
|
5824
5933
|
class RestoreDBClusterToPointInTimeMessage < Struct.new(
|
5825
5934
|
:db_cluster_identifier,
|
5935
|
+
:restore_type,
|
5826
5936
|
:source_db_cluster_identifier,
|
5827
5937
|
:restore_to_time,
|
5828
5938
|
:use_latest_restorable_time,
|
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.44.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-08-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|