aws-sdk-docdb 1.30.0 → 1.34.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-docdb.rb +1 -1
- data/lib/aws-sdk-docdb/client.rb +495 -140
- data/lib/aws-sdk-docdb/client_api.rb +162 -2
- data/lib/aws-sdk-docdb/errors.rb +44 -0
- data/lib/aws-sdk-docdb/types.rb +570 -158
- metadata +5 -6
@@ -47,6 +47,8 @@ module Aws::DocDB
|
|
47
47
|
CreateDBSubnetGroupResult = Shapes::StructureShape.new(name: 'CreateDBSubnetGroupResult')
|
48
48
|
CreateEventSubscriptionMessage = Shapes::StructureShape.new(name: 'CreateEventSubscriptionMessage')
|
49
49
|
CreateEventSubscriptionResult = Shapes::StructureShape.new(name: 'CreateEventSubscriptionResult')
|
50
|
+
CreateGlobalClusterMessage = Shapes::StructureShape.new(name: 'CreateGlobalClusterMessage')
|
51
|
+
CreateGlobalClusterResult = Shapes::StructureShape.new(name: 'CreateGlobalClusterResult')
|
50
52
|
DBCluster = Shapes::StructureShape.new(name: 'DBCluster')
|
51
53
|
DBClusterAlreadyExistsFault = Shapes::StructureShape.new(name: 'DBClusterAlreadyExistsFault')
|
52
54
|
DBClusterList = Shapes::ListShape.new(name: 'DBClusterList')
|
@@ -106,6 +108,8 @@ module Aws::DocDB
|
|
106
108
|
DeleteDBSubnetGroupMessage = Shapes::StructureShape.new(name: 'DeleteDBSubnetGroupMessage')
|
107
109
|
DeleteEventSubscriptionMessage = Shapes::StructureShape.new(name: 'DeleteEventSubscriptionMessage')
|
108
110
|
DeleteEventSubscriptionResult = Shapes::StructureShape.new(name: 'DeleteEventSubscriptionResult')
|
111
|
+
DeleteGlobalClusterMessage = Shapes::StructureShape.new(name: 'DeleteGlobalClusterMessage')
|
112
|
+
DeleteGlobalClusterResult = Shapes::StructureShape.new(name: 'DeleteGlobalClusterResult')
|
109
113
|
DescribeCertificatesMessage = Shapes::StructureShape.new(name: 'DescribeCertificatesMessage')
|
110
114
|
DescribeDBClusterParameterGroupsMessage = Shapes::StructureShape.new(name: 'DescribeDBClusterParameterGroupsMessage')
|
111
115
|
DescribeDBClusterParametersMessage = Shapes::StructureShape.new(name: 'DescribeDBClusterParametersMessage')
|
@@ -121,6 +125,7 @@ module Aws::DocDB
|
|
121
125
|
DescribeEventCategoriesMessage = Shapes::StructureShape.new(name: 'DescribeEventCategoriesMessage')
|
122
126
|
DescribeEventSubscriptionsMessage = Shapes::StructureShape.new(name: 'DescribeEventSubscriptionsMessage')
|
123
127
|
DescribeEventsMessage = Shapes::StructureShape.new(name: 'DescribeEventsMessage')
|
128
|
+
DescribeGlobalClustersMessage = Shapes::StructureShape.new(name: 'DescribeGlobalClustersMessage')
|
124
129
|
DescribeOrderableDBInstanceOptionsMessage = Shapes::StructureShape.new(name: 'DescribeOrderableDBInstanceOptionsMessage')
|
125
130
|
DescribePendingMaintenanceActionsMessage = Shapes::StructureShape.new(name: 'DescribePendingMaintenanceActionsMessage')
|
126
131
|
Endpoint = Shapes::StructureShape.new(name: 'Endpoint')
|
@@ -141,6 +146,15 @@ module Aws::DocDB
|
|
141
146
|
Filter = Shapes::StructureShape.new(name: 'Filter')
|
142
147
|
FilterList = Shapes::ListShape.new(name: 'FilterList')
|
143
148
|
FilterValueList = Shapes::ListShape.new(name: 'FilterValueList')
|
149
|
+
GlobalCluster = Shapes::StructureShape.new(name: 'GlobalCluster')
|
150
|
+
GlobalClusterAlreadyExistsFault = Shapes::StructureShape.new(name: 'GlobalClusterAlreadyExistsFault')
|
151
|
+
GlobalClusterIdentifier = Shapes::StringShape.new(name: 'GlobalClusterIdentifier')
|
152
|
+
GlobalClusterList = Shapes::ListShape.new(name: 'GlobalClusterList')
|
153
|
+
GlobalClusterMember = Shapes::StructureShape.new(name: 'GlobalClusterMember')
|
154
|
+
GlobalClusterMemberList = Shapes::ListShape.new(name: 'GlobalClusterMemberList')
|
155
|
+
GlobalClusterNotFoundFault = Shapes::StructureShape.new(name: 'GlobalClusterNotFoundFault')
|
156
|
+
GlobalClusterQuotaExceededFault = Shapes::StructureShape.new(name: 'GlobalClusterQuotaExceededFault')
|
157
|
+
GlobalClustersMessage = Shapes::StructureShape.new(name: 'GlobalClustersMessage')
|
144
158
|
InstanceQuotaExceededFault = Shapes::StructureShape.new(name: 'InstanceQuotaExceededFault')
|
145
159
|
InsufficientDBClusterCapacityFault = Shapes::StructureShape.new(name: 'InsufficientDBClusterCapacityFault')
|
146
160
|
InsufficientDBInstanceCapacityFault = Shapes::StructureShape.new(name: 'InsufficientDBInstanceCapacityFault')
|
@@ -156,6 +170,7 @@ module Aws::DocDB
|
|
156
170
|
InvalidDBSubnetGroupStateFault = Shapes::StructureShape.new(name: 'InvalidDBSubnetGroupStateFault')
|
157
171
|
InvalidDBSubnetStateFault = Shapes::StructureShape.new(name: 'InvalidDBSubnetStateFault')
|
158
172
|
InvalidEventSubscriptionStateFault = Shapes::StructureShape.new(name: 'InvalidEventSubscriptionStateFault')
|
173
|
+
InvalidGlobalClusterStateFault = Shapes::StructureShape.new(name: 'InvalidGlobalClusterStateFault')
|
159
174
|
InvalidRestoreFault = Shapes::StructureShape.new(name: 'InvalidRestoreFault')
|
160
175
|
InvalidSubnet = Shapes::StructureShape.new(name: 'InvalidSubnet')
|
161
176
|
InvalidVPCNetworkStateFault = Shapes::StructureShape.new(name: 'InvalidVPCNetworkStateFault')
|
@@ -174,6 +189,8 @@ module Aws::DocDB
|
|
174
189
|
ModifyDBSubnetGroupResult = Shapes::StructureShape.new(name: 'ModifyDBSubnetGroupResult')
|
175
190
|
ModifyEventSubscriptionMessage = Shapes::StructureShape.new(name: 'ModifyEventSubscriptionMessage')
|
176
191
|
ModifyEventSubscriptionResult = Shapes::StructureShape.new(name: 'ModifyEventSubscriptionResult')
|
192
|
+
ModifyGlobalClusterMessage = Shapes::StructureShape.new(name: 'ModifyGlobalClusterMessage')
|
193
|
+
ModifyGlobalClusterResult = Shapes::StructureShape.new(name: 'ModifyGlobalClusterResult')
|
177
194
|
OrderableDBInstanceOption = Shapes::StructureShape.new(name: 'OrderableDBInstanceOption')
|
178
195
|
OrderableDBInstanceOptionsList = Shapes::ListShape.new(name: 'OrderableDBInstanceOptionsList')
|
179
196
|
OrderableDBInstanceOptionsMessage = Shapes::StructureShape.new(name: 'OrderableDBInstanceOptionsMessage')
|
@@ -185,8 +202,12 @@ module Aws::DocDB
|
|
185
202
|
PendingMaintenanceActions = Shapes::ListShape.new(name: 'PendingMaintenanceActions')
|
186
203
|
PendingMaintenanceActionsMessage = Shapes::StructureShape.new(name: 'PendingMaintenanceActionsMessage')
|
187
204
|
PendingModifiedValues = Shapes::StructureShape.new(name: 'PendingModifiedValues')
|
205
|
+
ReadReplicaIdentifierList = Shapes::ListShape.new(name: 'ReadReplicaIdentifierList')
|
206
|
+
ReadersArnList = Shapes::ListShape.new(name: 'ReadersArnList')
|
188
207
|
RebootDBInstanceMessage = Shapes::StructureShape.new(name: 'RebootDBInstanceMessage')
|
189
208
|
RebootDBInstanceResult = Shapes::StructureShape.new(name: 'RebootDBInstanceResult')
|
209
|
+
RemoveFromGlobalClusterMessage = Shapes::StructureShape.new(name: 'RemoveFromGlobalClusterMessage')
|
210
|
+
RemoveFromGlobalClusterResult = Shapes::StructureShape.new(name: 'RemoveFromGlobalClusterResult')
|
190
211
|
RemoveSourceIdentifierFromSubscriptionMessage = Shapes::StructureShape.new(name: 'RemoveSourceIdentifierFromSubscriptionMessage')
|
191
212
|
RemoveSourceIdentifierFromSubscriptionResult = Shapes::StructureShape.new(name: 'RemoveSourceIdentifierFromSubscriptionResult')
|
192
213
|
RemoveTagsFromResourceMessage = Shapes::StructureShape.new(name: 'RemoveTagsFromResourceMessage')
|
@@ -309,8 +330,8 @@ module Aws::DocDB
|
|
309
330
|
CreateDBClusterMessage.add_member(:engine, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Engine"))
|
310
331
|
CreateDBClusterMessage.add_member(:engine_version, Shapes::ShapeRef.new(shape: String, location_name: "EngineVersion"))
|
311
332
|
CreateDBClusterMessage.add_member(:port, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "Port"))
|
312
|
-
CreateDBClusterMessage.add_member(:master_username, Shapes::ShapeRef.new(shape: String,
|
313
|
-
CreateDBClusterMessage.add_member(:master_user_password, Shapes::ShapeRef.new(shape: String,
|
333
|
+
CreateDBClusterMessage.add_member(:master_username, Shapes::ShapeRef.new(shape: String, location_name: "MasterUsername"))
|
334
|
+
CreateDBClusterMessage.add_member(:master_user_password, Shapes::ShapeRef.new(shape: String, location_name: "MasterUserPassword"))
|
314
335
|
CreateDBClusterMessage.add_member(:preferred_backup_window, Shapes::ShapeRef.new(shape: String, location_name: "PreferredBackupWindow"))
|
315
336
|
CreateDBClusterMessage.add_member(:preferred_maintenance_window, Shapes::ShapeRef.new(shape: String, location_name: "PreferredMaintenanceWindow"))
|
316
337
|
CreateDBClusterMessage.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
@@ -319,6 +340,7 @@ module Aws::DocDB
|
|
319
340
|
CreateDBClusterMessage.add_member(:pre_signed_url, Shapes::ShapeRef.new(shape: String, location_name: "PreSignedUrl"))
|
320
341
|
CreateDBClusterMessage.add_member(:enable_cloudwatch_logs_exports, Shapes::ShapeRef.new(shape: LogTypeList, location_name: "EnableCloudwatchLogsExports"))
|
321
342
|
CreateDBClusterMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
343
|
+
CreateDBClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, location_name: "GlobalClusterIdentifier"))
|
322
344
|
CreateDBClusterMessage.add_member(:source_region, Shapes::ShapeRef.new(shape: String, location_name: "SourceRegion"))
|
323
345
|
CreateDBClusterMessage.struct_class = Types::CreateDBClusterMessage
|
324
346
|
|
@@ -377,6 +399,18 @@ module Aws::DocDB
|
|
377
399
|
CreateEventSubscriptionResult.add_member(:event_subscription, Shapes::ShapeRef.new(shape: EventSubscription, location_name: "EventSubscription"))
|
378
400
|
CreateEventSubscriptionResult.struct_class = Types::CreateEventSubscriptionResult
|
379
401
|
|
402
|
+
CreateGlobalClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, required: true, location_name: "GlobalClusterIdentifier"))
|
403
|
+
CreateGlobalClusterMessage.add_member(:source_db_cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "SourceDBClusterIdentifier"))
|
404
|
+
CreateGlobalClusterMessage.add_member(:engine, Shapes::ShapeRef.new(shape: String, location_name: "Engine"))
|
405
|
+
CreateGlobalClusterMessage.add_member(:engine_version, Shapes::ShapeRef.new(shape: String, location_name: "EngineVersion"))
|
406
|
+
CreateGlobalClusterMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
407
|
+
CreateGlobalClusterMessage.add_member(:database_name, Shapes::ShapeRef.new(shape: String, location_name: "DatabaseName"))
|
408
|
+
CreateGlobalClusterMessage.add_member(:storage_encrypted, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "StorageEncrypted"))
|
409
|
+
CreateGlobalClusterMessage.struct_class = Types::CreateGlobalClusterMessage
|
410
|
+
|
411
|
+
CreateGlobalClusterResult.add_member(:global_cluster, Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalCluster"))
|
412
|
+
CreateGlobalClusterResult.struct_class = Types::CreateGlobalClusterResult
|
413
|
+
|
380
414
|
DBCluster.add_member(:availability_zones, Shapes::ShapeRef.new(shape: AvailabilityZones, location_name: "AvailabilityZones"))
|
381
415
|
DBCluster.add_member(:backup_retention_period, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "BackupRetentionPeriod"))
|
382
416
|
DBCluster.add_member(:db_cluster_identifier, Shapes::ShapeRef.new(shape: String, location_name: "DBClusterIdentifier"))
|
@@ -395,6 +429,8 @@ module Aws::DocDB
|
|
395
429
|
DBCluster.add_member(:master_username, Shapes::ShapeRef.new(shape: String, location_name: "MasterUsername"))
|
396
430
|
DBCluster.add_member(:preferred_backup_window, Shapes::ShapeRef.new(shape: String, location_name: "PreferredBackupWindow"))
|
397
431
|
DBCluster.add_member(:preferred_maintenance_window, Shapes::ShapeRef.new(shape: String, location_name: "PreferredMaintenanceWindow"))
|
432
|
+
DBCluster.add_member(:replication_source_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ReplicationSourceIdentifier"))
|
433
|
+
DBCluster.add_member(:read_replica_identifiers, Shapes::ShapeRef.new(shape: ReadReplicaIdentifierList, location_name: "ReadReplicaIdentifiers"))
|
398
434
|
DBCluster.add_member(:db_cluster_members, Shapes::ShapeRef.new(shape: DBClusterMemberList, location_name: "DBClusterMembers"))
|
399
435
|
DBCluster.add_member(:vpc_security_groups, Shapes::ShapeRef.new(shape: VpcSecurityGroupMembershipList, location_name: "VpcSecurityGroups"))
|
400
436
|
DBCluster.add_member(:hosted_zone_id, Shapes::ShapeRef.new(shape: String, location_name: "HostedZoneId"))
|
@@ -626,6 +662,12 @@ module Aws::DocDB
|
|
626
662
|
DeleteEventSubscriptionResult.add_member(:event_subscription, Shapes::ShapeRef.new(shape: EventSubscription, location_name: "EventSubscription"))
|
627
663
|
DeleteEventSubscriptionResult.struct_class = Types::DeleteEventSubscriptionResult
|
628
664
|
|
665
|
+
DeleteGlobalClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, required: true, location_name: "GlobalClusterIdentifier"))
|
666
|
+
DeleteGlobalClusterMessage.struct_class = Types::DeleteGlobalClusterMessage
|
667
|
+
|
668
|
+
DeleteGlobalClusterResult.add_member(:global_cluster, Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalCluster"))
|
669
|
+
DeleteGlobalClusterResult.struct_class = Types::DeleteGlobalClusterResult
|
670
|
+
|
629
671
|
DescribeCertificatesMessage.add_member(:certificate_identifier, Shapes::ShapeRef.new(shape: String, location_name: "CertificateIdentifier"))
|
630
672
|
DescribeCertificatesMessage.add_member(:filters, Shapes::ShapeRef.new(shape: FilterList, location_name: "Filters"))
|
631
673
|
DescribeCertificatesMessage.add_member(:max_records, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxRecords"))
|
@@ -720,6 +762,12 @@ module Aws::DocDB
|
|
720
762
|
DescribeEventsMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker"))
|
721
763
|
DescribeEventsMessage.struct_class = Types::DescribeEventsMessage
|
722
764
|
|
765
|
+
DescribeGlobalClustersMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, location_name: "GlobalClusterIdentifier"))
|
766
|
+
DescribeGlobalClustersMessage.add_member(:filters, Shapes::ShapeRef.new(shape: FilterList, location_name: "Filters"))
|
767
|
+
DescribeGlobalClustersMessage.add_member(:max_records, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxRecords"))
|
768
|
+
DescribeGlobalClustersMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker"))
|
769
|
+
DescribeGlobalClustersMessage.struct_class = Types::DescribeGlobalClustersMessage
|
770
|
+
|
723
771
|
DescribeOrderableDBInstanceOptionsMessage.add_member(:engine, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Engine"))
|
724
772
|
DescribeOrderableDBInstanceOptionsMessage.add_member(:engine_version, Shapes::ShapeRef.new(shape: String, location_name: "EngineVersion"))
|
725
773
|
DescribeOrderableDBInstanceOptionsMessage.add_member(:db_instance_class, Shapes::ShapeRef.new(shape: String, location_name: "DBInstanceClass"))
|
@@ -806,6 +854,37 @@ module Aws::DocDB
|
|
806
854
|
|
807
855
|
FilterValueList.member = Shapes::ShapeRef.new(shape: String, location_name: "Value")
|
808
856
|
|
857
|
+
GlobalCluster.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, location_name: "GlobalClusterIdentifier"))
|
858
|
+
GlobalCluster.add_member(:global_cluster_resource_id, Shapes::ShapeRef.new(shape: String, location_name: "GlobalClusterResourceId"))
|
859
|
+
GlobalCluster.add_member(:global_cluster_arn, Shapes::ShapeRef.new(shape: String, location_name: "GlobalClusterArn"))
|
860
|
+
GlobalCluster.add_member(:status, Shapes::ShapeRef.new(shape: String, location_name: "Status"))
|
861
|
+
GlobalCluster.add_member(:engine, Shapes::ShapeRef.new(shape: String, location_name: "Engine"))
|
862
|
+
GlobalCluster.add_member(:engine_version, Shapes::ShapeRef.new(shape: String, location_name: "EngineVersion"))
|
863
|
+
GlobalCluster.add_member(:database_name, Shapes::ShapeRef.new(shape: String, location_name: "DatabaseName"))
|
864
|
+
GlobalCluster.add_member(:storage_encrypted, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "StorageEncrypted"))
|
865
|
+
GlobalCluster.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
866
|
+
GlobalCluster.add_member(:global_cluster_members, Shapes::ShapeRef.new(shape: GlobalClusterMemberList, location_name: "GlobalClusterMembers"))
|
867
|
+
GlobalCluster.struct_class = Types::GlobalCluster
|
868
|
+
|
869
|
+
GlobalClusterAlreadyExistsFault.struct_class = Types::GlobalClusterAlreadyExistsFault
|
870
|
+
|
871
|
+
GlobalClusterList.member = Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalClusterMember")
|
872
|
+
|
873
|
+
GlobalClusterMember.add_member(:db_cluster_arn, Shapes::ShapeRef.new(shape: String, location_name: "DBClusterArn"))
|
874
|
+
GlobalClusterMember.add_member(:readers, Shapes::ShapeRef.new(shape: ReadersArnList, location_name: "Readers"))
|
875
|
+
GlobalClusterMember.add_member(:is_writer, Shapes::ShapeRef.new(shape: Boolean, location_name: "IsWriter"))
|
876
|
+
GlobalClusterMember.struct_class = Types::GlobalClusterMember
|
877
|
+
|
878
|
+
GlobalClusterMemberList.member = Shapes::ShapeRef.new(shape: GlobalClusterMember, location_name: "GlobalClusterMember")
|
879
|
+
|
880
|
+
GlobalClusterNotFoundFault.struct_class = Types::GlobalClusterNotFoundFault
|
881
|
+
|
882
|
+
GlobalClusterQuotaExceededFault.struct_class = Types::GlobalClusterQuotaExceededFault
|
883
|
+
|
884
|
+
GlobalClustersMessage.add_member(:marker, Shapes::ShapeRef.new(shape: String, location_name: "Marker"))
|
885
|
+
GlobalClustersMessage.add_member(:global_clusters, Shapes::ShapeRef.new(shape: GlobalClusterList, location_name: "GlobalClusters"))
|
886
|
+
GlobalClustersMessage.struct_class = Types::GlobalClustersMessage
|
887
|
+
|
809
888
|
InstanceQuotaExceededFault.struct_class = Types::InstanceQuotaExceededFault
|
810
889
|
|
811
890
|
InsufficientDBClusterCapacityFault.struct_class = Types::InsufficientDBClusterCapacityFault
|
@@ -832,6 +911,8 @@ module Aws::DocDB
|
|
832
911
|
|
833
912
|
InvalidEventSubscriptionStateFault.struct_class = Types::InvalidEventSubscriptionStateFault
|
834
913
|
|
914
|
+
InvalidGlobalClusterStateFault.struct_class = Types::InvalidGlobalClusterStateFault
|
915
|
+
|
835
916
|
InvalidRestoreFault.struct_class = Types::InvalidRestoreFault
|
836
917
|
|
837
918
|
InvalidSubnet.struct_class = Types::InvalidSubnet
|
@@ -910,6 +991,14 @@ module Aws::DocDB
|
|
910
991
|
ModifyEventSubscriptionResult.add_member(:event_subscription, Shapes::ShapeRef.new(shape: EventSubscription, location_name: "EventSubscription"))
|
911
992
|
ModifyEventSubscriptionResult.struct_class = Types::ModifyEventSubscriptionResult
|
912
993
|
|
994
|
+
ModifyGlobalClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, required: true, location_name: "GlobalClusterIdentifier"))
|
995
|
+
ModifyGlobalClusterMessage.add_member(:new_global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, location_name: "NewGlobalClusterIdentifier"))
|
996
|
+
ModifyGlobalClusterMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
997
|
+
ModifyGlobalClusterMessage.struct_class = Types::ModifyGlobalClusterMessage
|
998
|
+
|
999
|
+
ModifyGlobalClusterResult.add_member(:global_cluster, Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalCluster"))
|
1000
|
+
ModifyGlobalClusterResult.struct_class = Types::ModifyGlobalClusterResult
|
1001
|
+
|
913
1002
|
OrderableDBInstanceOption.add_member(:engine, Shapes::ShapeRef.new(shape: String, location_name: "Engine"))
|
914
1003
|
OrderableDBInstanceOption.add_member(:engine_version, Shapes::ShapeRef.new(shape: String, location_name: "EngineVersion"))
|
915
1004
|
OrderableDBInstanceOption.add_member(:db_instance_class, Shapes::ShapeRef.new(shape: String, location_name: "DBInstanceClass"))
|
@@ -974,6 +1063,10 @@ module Aws::DocDB
|
|
974
1063
|
PendingModifiedValues.add_member(:pending_cloudwatch_logs_exports, Shapes::ShapeRef.new(shape: PendingCloudwatchLogsExports, location_name: "PendingCloudwatchLogsExports"))
|
975
1064
|
PendingModifiedValues.struct_class = Types::PendingModifiedValues
|
976
1065
|
|
1066
|
+
ReadReplicaIdentifierList.member = Shapes::ShapeRef.new(shape: String, location_name: "ReadReplicaIdentifier")
|
1067
|
+
|
1068
|
+
ReadersArnList.member = Shapes::ShapeRef.new(shape: String)
|
1069
|
+
|
977
1070
|
RebootDBInstanceMessage.add_member(:db_instance_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBInstanceIdentifier"))
|
978
1071
|
RebootDBInstanceMessage.add_member(:force_failover, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ForceFailover"))
|
979
1072
|
RebootDBInstanceMessage.struct_class = Types::RebootDBInstanceMessage
|
@@ -981,6 +1074,13 @@ module Aws::DocDB
|
|
981
1074
|
RebootDBInstanceResult.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
982
1075
|
RebootDBInstanceResult.struct_class = Types::RebootDBInstanceResult
|
983
1076
|
|
1077
|
+
RemoveFromGlobalClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, required: true, location_name: "GlobalClusterIdentifier"))
|
1078
|
+
RemoveFromGlobalClusterMessage.add_member(:db_cluster_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DbClusterIdentifier"))
|
1079
|
+
RemoveFromGlobalClusterMessage.struct_class = Types::RemoveFromGlobalClusterMessage
|
1080
|
+
|
1081
|
+
RemoveFromGlobalClusterResult.add_member(:global_cluster, Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalCluster"))
|
1082
|
+
RemoveFromGlobalClusterResult.struct_class = Types::RemoveFromGlobalClusterResult
|
1083
|
+
|
984
1084
|
RemoveSourceIdentifierFromSubscriptionMessage.add_member(:subscription_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SubscriptionName"))
|
985
1085
|
RemoveSourceIdentifierFromSubscriptionMessage.add_member(:source_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SourceIdentifier"))
|
986
1086
|
RemoveSourceIdentifierFromSubscriptionMessage.struct_class = Types::RemoveSourceIdentifierFromSubscriptionMessage
|
@@ -1206,6 +1306,8 @@ module Aws::DocDB
|
|
1206
1306
|
o.errors << Shapes::ShapeRef.new(shape: DBClusterNotFoundFault)
|
1207
1307
|
o.errors << Shapes::ShapeRef.new(shape: DBInstanceNotFoundFault)
|
1208
1308
|
o.errors << Shapes::ShapeRef.new(shape: DBSubnetGroupDoesNotCoverEnoughAZs)
|
1309
|
+
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterNotFoundFault)
|
1310
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidGlobalClusterStateFault)
|
1209
1311
|
end)
|
1210
1312
|
|
1211
1313
|
api.add_operation(:create_db_cluster_parameter_group, Seahorse::Model::Operation.new.tap do |o|
|
@@ -1282,6 +1384,18 @@ module Aws::DocDB
|
|
1282
1384
|
o.errors << Shapes::ShapeRef.new(shape: SourceNotFoundFault)
|
1283
1385
|
end)
|
1284
1386
|
|
1387
|
+
api.add_operation(:create_global_cluster, Seahorse::Model::Operation.new.tap do |o|
|
1388
|
+
o.name = "CreateGlobalCluster"
|
1389
|
+
o.http_method = "POST"
|
1390
|
+
o.http_request_uri = "/"
|
1391
|
+
o.input = Shapes::ShapeRef.new(shape: CreateGlobalClusterMessage)
|
1392
|
+
o.output = Shapes::ShapeRef.new(shape: CreateGlobalClusterResult)
|
1393
|
+
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterAlreadyExistsFault)
|
1394
|
+
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterQuotaExceededFault)
|
1395
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidDBClusterStateFault)
|
1396
|
+
o.errors << Shapes::ShapeRef.new(shape: DBClusterNotFoundFault)
|
1397
|
+
end)
|
1398
|
+
|
1285
1399
|
api.add_operation(:delete_db_cluster, Seahorse::Model::Operation.new.tap do |o|
|
1286
1400
|
o.name = "DeleteDBCluster"
|
1287
1401
|
o.http_method = "POST"
|
@@ -1349,6 +1463,16 @@ module Aws::DocDB
|
|
1349
1463
|
o.errors << Shapes::ShapeRef.new(shape: InvalidEventSubscriptionStateFault)
|
1350
1464
|
end)
|
1351
1465
|
|
1466
|
+
api.add_operation(:delete_global_cluster, Seahorse::Model::Operation.new.tap do |o|
|
1467
|
+
o.name = "DeleteGlobalCluster"
|
1468
|
+
o.http_method = "POST"
|
1469
|
+
o.http_request_uri = "/"
|
1470
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteGlobalClusterMessage)
|
1471
|
+
o.output = Shapes::ShapeRef.new(shape: DeleteGlobalClusterResult)
|
1472
|
+
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterNotFoundFault)
|
1473
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidGlobalClusterStateFault)
|
1474
|
+
end)
|
1475
|
+
|
1352
1476
|
api.add_operation(:describe_certificates, Seahorse::Model::Operation.new.tap do |o|
|
1353
1477
|
o.name = "DescribeCertificates"
|
1354
1478
|
o.http_method = "POST"
|
@@ -1522,6 +1646,21 @@ module Aws::DocDB
|
|
1522
1646
|
)
|
1523
1647
|
end)
|
1524
1648
|
|
1649
|
+
api.add_operation(:describe_global_clusters, Seahorse::Model::Operation.new.tap do |o|
|
1650
|
+
o.name = "DescribeGlobalClusters"
|
1651
|
+
o.http_method = "POST"
|
1652
|
+
o.http_request_uri = "/"
|
1653
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeGlobalClustersMessage)
|
1654
|
+
o.output = Shapes::ShapeRef.new(shape: GlobalClustersMessage)
|
1655
|
+
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterNotFoundFault)
|
1656
|
+
o[:pager] = Aws::Pager.new(
|
1657
|
+
limit_key: "max_records",
|
1658
|
+
tokens: {
|
1659
|
+
"marker" => "marker"
|
1660
|
+
}
|
1661
|
+
)
|
1662
|
+
end)
|
1663
|
+
|
1525
1664
|
api.add_operation(:describe_orderable_db_instance_options, Seahorse::Model::Operation.new.tap do |o|
|
1526
1665
|
o.name = "DescribeOrderableDBInstanceOptions"
|
1527
1666
|
o.http_method = "POST"
|
@@ -1661,6 +1800,16 @@ module Aws::DocDB
|
|
1661
1800
|
o.errors << Shapes::ShapeRef.new(shape: SubscriptionCategoryNotFoundFault)
|
1662
1801
|
end)
|
1663
1802
|
|
1803
|
+
api.add_operation(:modify_global_cluster, Seahorse::Model::Operation.new.tap do |o|
|
1804
|
+
o.name = "ModifyGlobalCluster"
|
1805
|
+
o.http_method = "POST"
|
1806
|
+
o.http_request_uri = "/"
|
1807
|
+
o.input = Shapes::ShapeRef.new(shape: ModifyGlobalClusterMessage)
|
1808
|
+
o.output = Shapes::ShapeRef.new(shape: ModifyGlobalClusterResult)
|
1809
|
+
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterNotFoundFault)
|
1810
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidGlobalClusterStateFault)
|
1811
|
+
end)
|
1812
|
+
|
1664
1813
|
api.add_operation(:reboot_db_instance, Seahorse::Model::Operation.new.tap do |o|
|
1665
1814
|
o.name = "RebootDBInstance"
|
1666
1815
|
o.http_method = "POST"
|
@@ -1671,6 +1820,17 @@ module Aws::DocDB
|
|
1671
1820
|
o.errors << Shapes::ShapeRef.new(shape: DBInstanceNotFoundFault)
|
1672
1821
|
end)
|
1673
1822
|
|
1823
|
+
api.add_operation(:remove_from_global_cluster, Seahorse::Model::Operation.new.tap do |o|
|
1824
|
+
o.name = "RemoveFromGlobalCluster"
|
1825
|
+
o.http_method = "POST"
|
1826
|
+
o.http_request_uri = "/"
|
1827
|
+
o.input = Shapes::ShapeRef.new(shape: RemoveFromGlobalClusterMessage)
|
1828
|
+
o.output = Shapes::ShapeRef.new(shape: RemoveFromGlobalClusterResult)
|
1829
|
+
o.errors << Shapes::ShapeRef.new(shape: GlobalClusterNotFoundFault)
|
1830
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidGlobalClusterStateFault)
|
1831
|
+
o.errors << Shapes::ShapeRef.new(shape: DBClusterNotFoundFault)
|
1832
|
+
end)
|
1833
|
+
|
1674
1834
|
api.add_operation(:remove_source_identifier_from_subscription, Seahorse::Model::Operation.new.tap do |o|
|
1675
1835
|
o.name = "RemoveSourceIdentifierFromSubscription"
|
1676
1836
|
o.http_method = "POST"
|
data/lib/aws-sdk-docdb/errors.rb
CHANGED
@@ -50,6 +50,9 @@ module Aws::DocDB
|
|
50
50
|
# * {DBSubnetQuotaExceededFault}
|
51
51
|
# * {DBUpgradeDependencyFailureFault}
|
52
52
|
# * {EventSubscriptionQuotaExceededFault}
|
53
|
+
# * {GlobalClusterAlreadyExistsFault}
|
54
|
+
# * {GlobalClusterNotFoundFault}
|
55
|
+
# * {GlobalClusterQuotaExceededFault}
|
53
56
|
# * {InstanceQuotaExceededFault}
|
54
57
|
# * {InsufficientDBClusterCapacityFault}
|
55
58
|
# * {InsufficientDBInstanceCapacityFault}
|
@@ -63,6 +66,7 @@ module Aws::DocDB
|
|
63
66
|
# * {InvalidDBSubnetGroupStateFault}
|
64
67
|
# * {InvalidDBSubnetStateFault}
|
65
68
|
# * {InvalidEventSubscriptionStateFault}
|
69
|
+
# * {InvalidGlobalClusterStateFault}
|
66
70
|
# * {InvalidRestoreFault}
|
67
71
|
# * {InvalidSubnet}
|
68
72
|
# * {InvalidVPCNetworkStateFault}
|
@@ -317,6 +321,36 @@ module Aws::DocDB
|
|
317
321
|
end
|
318
322
|
end
|
319
323
|
|
324
|
+
class GlobalClusterAlreadyExistsFault < ServiceError
|
325
|
+
|
326
|
+
# @param [Seahorse::Client::RequestContext] context
|
327
|
+
# @param [String] message
|
328
|
+
# @param [Aws::DocDB::Types::GlobalClusterAlreadyExistsFault] data
|
329
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
330
|
+
super(context, message, data)
|
331
|
+
end
|
332
|
+
end
|
333
|
+
|
334
|
+
class GlobalClusterNotFoundFault < ServiceError
|
335
|
+
|
336
|
+
# @param [Seahorse::Client::RequestContext] context
|
337
|
+
# @param [String] message
|
338
|
+
# @param [Aws::DocDB::Types::GlobalClusterNotFoundFault] data
|
339
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
340
|
+
super(context, message, data)
|
341
|
+
end
|
342
|
+
end
|
343
|
+
|
344
|
+
class GlobalClusterQuotaExceededFault < ServiceError
|
345
|
+
|
346
|
+
# @param [Seahorse::Client::RequestContext] context
|
347
|
+
# @param [String] message
|
348
|
+
# @param [Aws::DocDB::Types::GlobalClusterQuotaExceededFault] data
|
349
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
350
|
+
super(context, message, data)
|
351
|
+
end
|
352
|
+
end
|
353
|
+
|
320
354
|
class InstanceQuotaExceededFault < ServiceError
|
321
355
|
|
322
356
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -447,6 +481,16 @@ module Aws::DocDB
|
|
447
481
|
end
|
448
482
|
end
|
449
483
|
|
484
|
+
class InvalidGlobalClusterStateFault < ServiceError
|
485
|
+
|
486
|
+
# @param [Seahorse::Client::RequestContext] context
|
487
|
+
# @param [String] message
|
488
|
+
# @param [Aws::DocDB::Types::InvalidGlobalClusterStateFault] data
|
489
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
490
|
+
super(context, message, data)
|
491
|
+
end
|
492
|
+
end
|
493
|
+
|
450
494
|
class InvalidRestoreFault < ServiceError
|
451
495
|
|
452
496
|
# @param [Seahorse::Client::RequestContext] context
|
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`.
|
@@ -537,8 +535,8 @@ module Aws::DocDB
|
|
537
535
|
# engine: "String", # required
|
538
536
|
# engine_version: "String",
|
539
537
|
# port: 1,
|
540
|
-
# master_username: "String",
|
541
|
-
# master_user_password: "String",
|
538
|
+
# master_username: "String",
|
539
|
+
# master_user_password: "String",
|
542
540
|
# preferred_backup_window: "String",
|
543
541
|
# preferred_maintenance_window: "String",
|
544
542
|
# tags: [
|
@@ -552,6 +550,7 @@ module Aws::DocDB
|
|
552
550
|
# pre_signed_url: "String",
|
553
551
|
# enable_cloudwatch_logs_exports: ["String"],
|
554
552
|
# deletion_protection: false,
|
553
|
+
# global_cluster_identifier: "GlobalClusterIdentifier",
|
555
554
|
# source_region: "String",
|
556
555
|
# }
|
557
556
|
#
|
@@ -614,7 +613,7 @@ module Aws::DocDB
|
|
614
613
|
#
|
615
614
|
# @!attribute [rw] engine_version
|
616
615
|
# The version number of the database engine to use. The
|
617
|
-
#
|
616
|
+
# `--engine-version` will default to the latest major engine version.
|
618
617
|
# For production workloads, we recommend explicitly declaring this
|
619
618
|
# parameter with the intended major engine version.
|
620
619
|
# @return [String]
|
@@ -650,7 +649,7 @@ module Aws::DocDB
|
|
650
649
|
# parameter.
|
651
650
|
#
|
652
651
|
# The default is a 30-minute window selected at random from an 8-hour
|
653
|
-
# block of time for each
|
652
|
+
# block of time for each Region.
|
654
653
|
#
|
655
654
|
# Constraints:
|
656
655
|
#
|
@@ -670,7 +669,7 @@ module Aws::DocDB
|
|
670
669
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
671
670
|
#
|
672
671
|
# The default is a 30-minute window selected at random from an 8-hour
|
673
|
-
# block of time for each
|
672
|
+
# block of time for each Region, occurring on a random day of the
|
674
673
|
# week.
|
675
674
|
#
|
676
675
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
@@ -687,13 +686,13 @@ module Aws::DocDB
|
|
687
686
|
# @return [Boolean]
|
688
687
|
#
|
689
688
|
# @!attribute [rw] kms_key_id
|
690
|
-
# The
|
689
|
+
# The KMS key identifier for an encrypted cluster.
|
691
690
|
#
|
692
|
-
# The
|
693
|
-
#
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
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.
|
697
696
|
#
|
698
697
|
# If an encryption key is not specified in `KmsKeyId`\:
|
699
698
|
#
|
@@ -702,9 +701,8 @@ module Aws::DocDB
|
|
702
701
|
#
|
703
702
|
# ^
|
704
703
|
#
|
705
|
-
#
|
706
|
-
#
|
707
|
-
# Region.
|
704
|
+
# KMS creates the default encryption key for your account. Your
|
705
|
+
# account has a different default encryption key for each Regions.
|
708
706
|
# @return [String]
|
709
707
|
#
|
710
708
|
# @!attribute [rw] pre_signed_url
|
@@ -731,6 +729,10 @@ module Aws::DocDB
|
|
731
729
|
# deleted.
|
732
730
|
# @return [Boolean]
|
733
731
|
#
|
732
|
+
# @!attribute [rw] global_cluster_identifier
|
733
|
+
# The cluster identifier of the new global cluster.
|
734
|
+
# @return [String]
|
735
|
+
#
|
734
736
|
# @!attribute [rw] source_region
|
735
737
|
# The source region of the snapshot. This is only needed when the
|
736
738
|
# shapshot is encrypted and in a different region.
|
@@ -758,6 +760,7 @@ module Aws::DocDB
|
|
758
760
|
:pre_signed_url,
|
759
761
|
:enable_cloudwatch_logs_exports,
|
760
762
|
:deletion_protection,
|
763
|
+
:global_cluster_identifier,
|
761
764
|
:source_region)
|
762
765
|
SENSITIVE = []
|
763
766
|
include Aws::Structure
|
@@ -963,7 +966,7 @@ module Aws::DocDB
|
|
963
966
|
# The Amazon EC2 Availability Zone that the instance is created in.
|
964
967
|
#
|
965
968
|
# Default: A random, system-chosen Availability Zone in the
|
966
|
-
# endpoint's
|
969
|
+
# endpoint's Region.
|
967
970
|
#
|
968
971
|
# Example: `us-east-1d`
|
969
972
|
# @return [String]
|
@@ -975,7 +978,7 @@ module Aws::DocDB
|
|
975
978
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
976
979
|
#
|
977
980
|
# The default is a 30-minute window selected at random from an 8-hour
|
978
|
-
# block of time for each
|
981
|
+
# block of time for each Region, occurring on a random day of the
|
979
982
|
# week.
|
980
983
|
#
|
981
984
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
@@ -984,10 +987,11 @@ module Aws::DocDB
|
|
984
987
|
# @return [String]
|
985
988
|
#
|
986
989
|
# @!attribute [rw] auto_minor_version_upgrade
|
987
|
-
#
|
988
|
-
#
|
990
|
+
# This parameter does not apply to Amazon DocumentDB. Amazon
|
991
|
+
# DocumentDB does not perform minor version upgrades regardless of the
|
992
|
+
# value set.
|
989
993
|
#
|
990
|
-
# Default: `
|
994
|
+
# Default: `false`
|
991
995
|
# @return [Boolean]
|
992
996
|
#
|
993
997
|
# @!attribute [rw] tags
|
@@ -1138,7 +1142,7 @@ module Aws::DocDB
|
|
1138
1142
|
# specified, all events are returned.
|
1139
1143
|
#
|
1140
1144
|
# Valid values: `db-instance`, `db-cluster`, `db-parameter-group`,
|
1141
|
-
# `db-security-group`, `db-
|
1145
|
+
# `db-security-group`, `db-cluster-snapshot`
|
1142
1146
|
# @return [String]
|
1143
1147
|
#
|
1144
1148
|
# @!attribute [rw] event_categories
|
@@ -1205,6 +1209,80 @@ module Aws::DocDB
|
|
1205
1209
|
include Aws::Structure
|
1206
1210
|
end
|
1207
1211
|
|
1212
|
+
# Represents the input to CreateGlobalCluster.
|
1213
|
+
#
|
1214
|
+
# @note When making an API call, you may pass CreateGlobalClusterMessage
|
1215
|
+
# data as a hash:
|
1216
|
+
#
|
1217
|
+
# {
|
1218
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
1219
|
+
# source_db_cluster_identifier: "String",
|
1220
|
+
# engine: "String",
|
1221
|
+
# engine_version: "String",
|
1222
|
+
# deletion_protection: false,
|
1223
|
+
# database_name: "String",
|
1224
|
+
# storage_encrypted: false,
|
1225
|
+
# }
|
1226
|
+
#
|
1227
|
+
# @!attribute [rw] global_cluster_identifier
|
1228
|
+
# The cluster identifier of the new global cluster.
|
1229
|
+
# @return [String]
|
1230
|
+
#
|
1231
|
+
# @!attribute [rw] source_db_cluster_identifier
|
1232
|
+
# The Amazon Resource Name (ARN) to use as the primary cluster of the
|
1233
|
+
# global cluster. This parameter is optional.
|
1234
|
+
# @return [String]
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] engine
|
1237
|
+
# The name of the database engine to be used for this cluster.
|
1238
|
+
# @return [String]
|
1239
|
+
#
|
1240
|
+
# @!attribute [rw] engine_version
|
1241
|
+
# The engine version of the global cluster.
|
1242
|
+
# @return [String]
|
1243
|
+
#
|
1244
|
+
# @!attribute [rw] deletion_protection
|
1245
|
+
# The deletion protection setting for the new global cluster. The
|
1246
|
+
# global cluster can't be deleted when deletion protection is
|
1247
|
+
# enabled.
|
1248
|
+
# @return [Boolean]
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] database_name
|
1251
|
+
# The name for your database of up to 64 alpha-numeric characters. If
|
1252
|
+
# you do not provide a name, Amazon DocumentDB will not create a
|
1253
|
+
# database in the global cluster you are creating.
|
1254
|
+
# @return [String]
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] storage_encrypted
|
1257
|
+
# The storage encryption setting for the new global cluster.
|
1258
|
+
# @return [Boolean]
|
1259
|
+
#
|
1260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateGlobalClusterMessage AWS API Documentation
|
1261
|
+
#
|
1262
|
+
class CreateGlobalClusterMessage < Struct.new(
|
1263
|
+
:global_cluster_identifier,
|
1264
|
+
:source_db_cluster_identifier,
|
1265
|
+
:engine,
|
1266
|
+
:engine_version,
|
1267
|
+
:deletion_protection,
|
1268
|
+
:database_name,
|
1269
|
+
:storage_encrypted)
|
1270
|
+
SENSITIVE = []
|
1271
|
+
include Aws::Structure
|
1272
|
+
end
|
1273
|
+
|
1274
|
+
# @!attribute [rw] global_cluster
|
1275
|
+
# A data type representing an Amazon DocumentDB global cluster.
|
1276
|
+
# @return [Types::GlobalCluster]
|
1277
|
+
#
|
1278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateGlobalClusterResult AWS API Documentation
|
1279
|
+
#
|
1280
|
+
class CreateGlobalClusterResult < Struct.new(
|
1281
|
+
:global_cluster)
|
1282
|
+
SENSITIVE = []
|
1283
|
+
include Aws::Structure
|
1284
|
+
end
|
1285
|
+
|
1208
1286
|
# Detailed information about a cluster.
|
1209
1287
|
#
|
1210
1288
|
# @!attribute [rw] availability_zones
|
@@ -1304,6 +1382,16 @@ module Aws::DocDB
|
|
1304
1382
|
# occur, in Universal Coordinated Time (UTC).
|
1305
1383
|
# @return [String]
|
1306
1384
|
#
|
1385
|
+
# @!attribute [rw] replication_source_identifier
|
1386
|
+
# Contains the identifier of the source cluster if this cluster is a
|
1387
|
+
# secondary cluster.
|
1388
|
+
# @return [String]
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] read_replica_identifiers
|
1391
|
+
# Contains one or more identifiers of the secondary clusters that are
|
1392
|
+
# associated with this cluster.
|
1393
|
+
# @return [Array<String>]
|
1394
|
+
#
|
1307
1395
|
# @!attribute [rw] db_cluster_members
|
1308
1396
|
# Provides the list of instances that make up the cluster.
|
1309
1397
|
# @return [Array<Types::DBClusterMember>]
|
@@ -1323,14 +1411,14 @@ module Aws::DocDB
|
|
1323
1411
|
# @return [Boolean]
|
1324
1412
|
#
|
1325
1413
|
# @!attribute [rw] kms_key_id
|
1326
|
-
# If `StorageEncrypted` is `true`, the
|
1414
|
+
# If `StorageEncrypted` is `true`, the KMS key identifier for the
|
1327
1415
|
# encrypted cluster.
|
1328
1416
|
# @return [String]
|
1329
1417
|
#
|
1330
1418
|
# @!attribute [rw] db_cluster_resource_id
|
1331
|
-
# The
|
1332
|
-
# identifier is found in
|
1333
|
-
#
|
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.
|
1334
1422
|
# @return [String]
|
1335
1423
|
#
|
1336
1424
|
# @!attribute [rw] db_cluster_arn
|
@@ -1338,10 +1426,10 @@ module Aws::DocDB
|
|
1338
1426
|
# @return [String]
|
1339
1427
|
#
|
1340
1428
|
# @!attribute [rw] associated_roles
|
1341
|
-
# Provides a list of the
|
1342
|
-
#
|
1429
|
+
# Provides a list of the Identity and Access Management (IAM) roles
|
1430
|
+
# that are associated with the cluster. (IAM) roles that are
|
1343
1431
|
# associated with a cluster grant permission for the cluster to access
|
1344
|
-
# other
|
1432
|
+
# other Amazon Web Services services on your behalf.
|
1345
1433
|
# @return [Array<Types::DBClusterRole>]
|
1346
1434
|
#
|
1347
1435
|
# @!attribute [rw] cluster_create_time
|
@@ -1383,6 +1471,8 @@ module Aws::DocDB
|
|
1383
1471
|
:master_username,
|
1384
1472
|
:preferred_backup_window,
|
1385
1473
|
:preferred_maintenance_window,
|
1474
|
+
:replication_source_identifier,
|
1475
|
+
:read_replica_identifiers,
|
1386
1476
|
:db_cluster_members,
|
1387
1477
|
:vpc_security_groups,
|
1388
1478
|
:hosted_zone_id,
|
@@ -1577,27 +1667,27 @@ module Aws::DocDB
|
|
1577
1667
|
#
|
1578
1668
|
class DBClusterQuotaExceededFault < Aws::EmptyStructure; end
|
1579
1669
|
|
1580
|
-
# Describes an
|
1670
|
+
# Describes an Identity and Access Management (IAM) role that is
|
1581
1671
|
# associated with a cluster.
|
1582
1672
|
#
|
1583
1673
|
# @!attribute [rw] role_arn
|
1584
|
-
# The Amazon Resource Name (ARN) of the
|
1674
|
+
# The Amazon Resource Name (ARN) of the IAMrole that is associated
|
1585
1675
|
# with the DB cluster.
|
1586
1676
|
# @return [String]
|
1587
1677
|
#
|
1588
1678
|
# @!attribute [rw] status
|
1589
|
-
# Describes the state of association between the
|
1679
|
+
# Describes the state of association between the IAMrole and the
|
1590
1680
|
# cluster. The `Status` property returns one of the following values:
|
1591
1681
|
#
|
1592
|
-
# * `ACTIVE` - The
|
1593
|
-
# 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.
|
1594
1685
|
#
|
1595
|
-
# * `PENDING` - The
|
1596
|
-
# cluster.
|
1686
|
+
# * `PENDING` - The IAMrole ARN is being associated with the cluster.
|
1597
1687
|
#
|
1598
|
-
# * `INVALID` - The
|
1599
|
-
# the cluster cannot assume the
|
1600
|
-
# 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.
|
1601
1691
|
# @return [String]
|
1602
1692
|
#
|
1603
1693
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterRole AWS API Documentation
|
@@ -1675,7 +1765,7 @@ module Aws::DocDB
|
|
1675
1765
|
# @return [Boolean]
|
1676
1766
|
#
|
1677
1767
|
# @!attribute [rw] kms_key_id
|
1678
|
-
# If `StorageEncrypted` is `true`, the
|
1768
|
+
# If `StorageEncrypted` is `true`, the KMS key identifier for the
|
1679
1769
|
# encrypted cluster snapshot.
|
1680
1770
|
# @return [String]
|
1681
1771
|
#
|
@@ -1720,24 +1810,24 @@ module Aws::DocDB
|
|
1720
1810
|
|
1721
1811
|
# Contains the name and values of a manual cluster snapshot attribute.
|
1722
1812
|
#
|
1723
|
-
# Manual cluster snapshot attributes are used to authorize other
|
1813
|
+
# Manual cluster snapshot attributes are used to authorize other
|
1724
1814
|
# accounts to restore a manual cluster snapshot.
|
1725
1815
|
#
|
1726
1816
|
# @!attribute [rw] attribute_name
|
1727
1817
|
# The name of the manual cluster snapshot attribute.
|
1728
1818
|
#
|
1729
|
-
# The attribute named `restore` refers to the list of
|
1730
|
-
#
|
1819
|
+
# The attribute named `restore` refers to the list of accounts that
|
1820
|
+
# have permission to copy or restore the manual cluster snapshot.
|
1731
1821
|
# @return [String]
|
1732
1822
|
#
|
1733
1823
|
# @!attribute [rw] attribute_values
|
1734
1824
|
# The values for the manual cluster snapshot attribute.
|
1735
1825
|
#
|
1736
1826
|
# If the `AttributeName` field is set to `restore`, then this element
|
1737
|
-
# returns a list of IDs of the
|
1738
|
-
#
|
1739
|
-
#
|
1740
|
-
#
|
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.
|
1741
1831
|
# @return [Array<String>]
|
1742
1832
|
#
|
1743
1833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttribute AWS API Documentation
|
@@ -1947,7 +2037,9 @@ module Aws::DocDB
|
|
1947
2037
|
# @return [String]
|
1948
2038
|
#
|
1949
2039
|
# @!attribute [rw] auto_minor_version_upgrade
|
1950
|
-
#
|
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.
|
1951
2043
|
# @return [Boolean]
|
1952
2044
|
#
|
1953
2045
|
# @!attribute [rw] publicly_accessible
|
@@ -1970,14 +2062,14 @@ module Aws::DocDB
|
|
1970
2062
|
# @return [Boolean]
|
1971
2063
|
#
|
1972
2064
|
# @!attribute [rw] kms_key_id
|
1973
|
-
# If `StorageEncrypted` is `true`, the
|
2065
|
+
# If `StorageEncrypted` is `true`, the KMS key identifier for the
|
1974
2066
|
# encrypted instance.
|
1975
2067
|
# @return [String]
|
1976
2068
|
#
|
1977
2069
|
# @!attribute [rw] dbi_resource_id
|
1978
|
-
# The
|
1979
|
-
# identifier is found in
|
1980
|
-
#
|
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.
|
1981
2073
|
# @return [String]
|
1982
2074
|
#
|
1983
2075
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -1996,7 +2088,7 @@ module Aws::DocDB
|
|
1996
2088
|
#
|
1997
2089
|
# @!attribute [rw] enabled_cloudwatch_logs_exports
|
1998
2090
|
# A list of log types that this instance is configured to export to
|
1999
|
-
#
|
2091
|
+
# CloudWatch Logs.
|
2000
2092
|
# @return [Array<String>]
|
2001
2093
|
#
|
2002
2094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstance AWS API Documentation
|
@@ -2482,6 +2574,39 @@ module Aws::DocDB
|
|
2482
2574
|
include Aws::Structure
|
2483
2575
|
end
|
2484
2576
|
|
2577
|
+
# Represents the input to DeleteGlobalCluster.
|
2578
|
+
#
|
2579
|
+
# @note When making an API call, you may pass DeleteGlobalClusterMessage
|
2580
|
+
# data as a hash:
|
2581
|
+
#
|
2582
|
+
# {
|
2583
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
2584
|
+
# }
|
2585
|
+
#
|
2586
|
+
# @!attribute [rw] global_cluster_identifier
|
2587
|
+
# The cluster identifier of the global cluster being deleted.
|
2588
|
+
# @return [String]
|
2589
|
+
#
|
2590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteGlobalClusterMessage AWS API Documentation
|
2591
|
+
#
|
2592
|
+
class DeleteGlobalClusterMessage < Struct.new(
|
2593
|
+
:global_cluster_identifier)
|
2594
|
+
SENSITIVE = []
|
2595
|
+
include Aws::Structure
|
2596
|
+
end
|
2597
|
+
|
2598
|
+
# @!attribute [rw] global_cluster
|
2599
|
+
# A data type representing an Amazon DocumentDB global cluster.
|
2600
|
+
# @return [Types::GlobalCluster]
|
2601
|
+
#
|
2602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteGlobalClusterResult AWS API Documentation
|
2603
|
+
#
|
2604
|
+
class DeleteGlobalClusterResult < Struct.new(
|
2605
|
+
:global_cluster)
|
2606
|
+
SENSITIVE = []
|
2607
|
+
include Aws::Structure
|
2608
|
+
end
|
2609
|
+
|
2485
2610
|
# @note When making an API call, you may pass DescribeCertificatesMessage
|
2486
2611
|
# data as a hash:
|
2487
2612
|
#
|
@@ -2763,13 +2888,13 @@ module Aws::DocDB
|
|
2763
2888
|
# the following values:
|
2764
2889
|
#
|
2765
2890
|
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2766
|
-
# has automatically created for your
|
2891
|
+
# has automatically created for your account.
|
2767
2892
|
#
|
2768
2893
|
# * `manual` - Return all cluster snapshots that you have manually
|
2769
|
-
# created for your
|
2894
|
+
# created for your account.
|
2770
2895
|
#
|
2771
2896
|
# * `shared` - Return all manual cluster snapshots that have been
|
2772
|
-
# shared to your
|
2897
|
+
# shared to your account.
|
2773
2898
|
#
|
2774
2899
|
# * `public` - Return all cluster snapshots that have been marked as
|
2775
2900
|
# public.
|
@@ -2778,7 +2903,7 @@ module Aws::DocDB
|
|
2778
2903
|
# and manual cluster snapshots are returned. You can include shared
|
2779
2904
|
# cluster snapshots with these results by setting the `IncludeShared`
|
2780
2905
|
# parameter to `true`. You can include public cluster snapshots with
|
2781
|
-
# these results by setting the
|
2906
|
+
# these results by setting the`IncludePublic` parameter to `true`.
|
2782
2907
|
#
|
2783
2908
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
2784
2909
|
# `SnapshotType` values of `manual` or `automated`. The
|
@@ -2810,14 +2935,14 @@ module Aws::DocDB
|
|
2810
2935
|
#
|
2811
2936
|
# @!attribute [rw] include_shared
|
2812
2937
|
# Set to `true` to include shared manual cluster snapshots from other
|
2813
|
-
#
|
2814
|
-
#
|
2938
|
+
# accounts that this account has been given permission to copy or
|
2939
|
+
# restore, and otherwise `false`. The default is `false`.
|
2815
2940
|
# @return [Boolean]
|
2816
2941
|
#
|
2817
2942
|
# @!attribute [rw] include_public
|
2818
2943
|
# Set to `true` to include manual cluster snapshots that are public
|
2819
|
-
# and can be copied or restored by any
|
2820
|
-
#
|
2944
|
+
# and can be copied or restored by any account, and otherwise `false`.
|
2945
|
+
# The default is `false`.
|
2821
2946
|
# @return [Boolean]
|
2822
2947
|
#
|
2823
2948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotsMessage AWS API Documentation
|
@@ -3212,7 +3337,7 @@ module Aws::DocDB
|
|
3212
3337
|
# The type of source that is generating the events.
|
3213
3338
|
#
|
3214
3339
|
# Valid values: `db-instance`, `db-parameter-group`,
|
3215
|
-
# `db-security-group
|
3340
|
+
# `db-security-group`
|
3216
3341
|
# @return [String]
|
3217
3342
|
#
|
3218
3343
|
# @!attribute [rw] filters
|
@@ -3395,6 +3520,60 @@ module Aws::DocDB
|
|
3395
3520
|
include Aws::Structure
|
3396
3521
|
end
|
3397
3522
|
|
3523
|
+
# @note When making an API call, you may pass DescribeGlobalClustersMessage
|
3524
|
+
# data as a hash:
|
3525
|
+
#
|
3526
|
+
# {
|
3527
|
+
# global_cluster_identifier: "GlobalClusterIdentifier",
|
3528
|
+
# filters: [
|
3529
|
+
# {
|
3530
|
+
# name: "String", # required
|
3531
|
+
# values: ["String"], # required
|
3532
|
+
# },
|
3533
|
+
# ],
|
3534
|
+
# max_records: 1,
|
3535
|
+
# marker: "String",
|
3536
|
+
# }
|
3537
|
+
#
|
3538
|
+
# @!attribute [rw] global_cluster_identifier
|
3539
|
+
# The user-supplied cluster identifier. If this parameter is
|
3540
|
+
# specified, information from only the specific cluster is returned.
|
3541
|
+
# This parameter isn't case-sensitive.
|
3542
|
+
# @return [String]
|
3543
|
+
#
|
3544
|
+
# @!attribute [rw] filters
|
3545
|
+
# A filter that specifies one or more global DB clusters to describe.
|
3546
|
+
#
|
3547
|
+
# Supported filters: `db-cluster-id` accepts cluster identifiers and
|
3548
|
+
# cluster Amazon Resource Names (ARNs). The results list will only
|
3549
|
+
# include information about the clusters identified by these ARNs.
|
3550
|
+
# @return [Array<Types::Filter>]
|
3551
|
+
#
|
3552
|
+
# @!attribute [rw] max_records
|
3553
|
+
# The maximum number of records to include in the response. If more
|
3554
|
+
# records exist than the specified `MaxRecords` value, a pagination
|
3555
|
+
# token called a marker is included in the response so that you can
|
3556
|
+
# retrieve the remaining results.
|
3557
|
+
# @return [Integer]
|
3558
|
+
#
|
3559
|
+
# @!attribute [rw] marker
|
3560
|
+
# An optional pagination token provided by a previous
|
3561
|
+
# `DescribeGlobalClusters` request. If this parameter is specified,
|
3562
|
+
# the response includes only records beyond the marker, up to the
|
3563
|
+
# value specified by `MaxRecords`.
|
3564
|
+
# @return [String]
|
3565
|
+
#
|
3566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeGlobalClustersMessage AWS API Documentation
|
3567
|
+
#
|
3568
|
+
class DescribeGlobalClustersMessage < Struct.new(
|
3569
|
+
:global_cluster_identifier,
|
3570
|
+
:filters,
|
3571
|
+
:max_records,
|
3572
|
+
:marker)
|
3573
|
+
SENSITIVE = []
|
3574
|
+
include Aws::Structure
|
3575
|
+
end
|
3576
|
+
|
3398
3577
|
# Represents the input to DescribeOrderableDBInstanceOptions.
|
3399
3578
|
#
|
3400
3579
|
# @note When making an API call, you may pass DescribeOrderableDBInstanceOptionsMessage
|
@@ -3670,8 +3849,8 @@ module Aws::DocDB
|
|
3670
3849
|
# Detailed information about an event to which you have subscribed.
|
3671
3850
|
#
|
3672
3851
|
# @!attribute [rw] customer_aws_id
|
3673
|
-
# The
|
3674
|
-
# DocumentDB event notification subscription.
|
3852
|
+
# The Amazon Web Services customer account that is associated with the
|
3853
|
+
# Amazon DocumentDB event notification subscription.
|
3675
3854
|
# @return [String]
|
3676
3855
|
#
|
3677
3856
|
# @!attribute [rw] cust_subscription_id
|
@@ -3871,6 +4050,134 @@ module Aws::DocDB
|
|
3871
4050
|
include Aws::Structure
|
3872
4051
|
end
|
3873
4052
|
|
4053
|
+
# A data type representing an Amazon DocumentDB global cluster.
|
4054
|
+
#
|
4055
|
+
# @!attribute [rw] global_cluster_identifier
|
4056
|
+
# Contains a user-supplied global cluster identifier. This identifier
|
4057
|
+
# is the unique key that identifies a global cluster.
|
4058
|
+
# @return [String]
|
4059
|
+
#
|
4060
|
+
# @!attribute [rw] global_cluster_resource_id
|
4061
|
+
# The Region-unique, immutable identifier for the global database
|
4062
|
+
# cluster. This identifier is found in AWS CloudTrail log entries
|
4063
|
+
# whenever the AWS KMS customer master key (CMK) for the cluster is
|
4064
|
+
# accessed.
|
4065
|
+
# @return [String]
|
4066
|
+
#
|
4067
|
+
# @!attribute [rw] global_cluster_arn
|
4068
|
+
# The Amazon Resource Name (ARN) for the global cluster.
|
4069
|
+
# @return [String]
|
4070
|
+
#
|
4071
|
+
# @!attribute [rw] status
|
4072
|
+
# Specifies the current state of this global cluster.
|
4073
|
+
# @return [String]
|
4074
|
+
#
|
4075
|
+
# @!attribute [rw] engine
|
4076
|
+
# The Amazon DocumentDB database engine used by the global cluster.
|
4077
|
+
# @return [String]
|
4078
|
+
#
|
4079
|
+
# @!attribute [rw] engine_version
|
4080
|
+
# Indicates the database engine version.
|
4081
|
+
# @return [String]
|
4082
|
+
#
|
4083
|
+
# @!attribute [rw] database_name
|
4084
|
+
# The default database name within the new global cluster.
|
4085
|
+
# @return [String]
|
4086
|
+
#
|
4087
|
+
# @!attribute [rw] storage_encrypted
|
4088
|
+
# The storage encryption setting for the global cluster.
|
4089
|
+
# @return [Boolean]
|
4090
|
+
#
|
4091
|
+
# @!attribute [rw] deletion_protection
|
4092
|
+
# The deletion protection setting for the new global cluster.
|
4093
|
+
# @return [Boolean]
|
4094
|
+
#
|
4095
|
+
# @!attribute [rw] global_cluster_members
|
4096
|
+
# The list of cluster IDs for secondary clusters within the global
|
4097
|
+
# cluster. Currently limited to one item.
|
4098
|
+
# @return [Array<Types::GlobalClusterMember>]
|
4099
|
+
#
|
4100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/GlobalCluster AWS API Documentation
|
4101
|
+
#
|
4102
|
+
class GlobalCluster < Struct.new(
|
4103
|
+
:global_cluster_identifier,
|
4104
|
+
:global_cluster_resource_id,
|
4105
|
+
:global_cluster_arn,
|
4106
|
+
:status,
|
4107
|
+
:engine,
|
4108
|
+
:engine_version,
|
4109
|
+
:database_name,
|
4110
|
+
:storage_encrypted,
|
4111
|
+
:deletion_protection,
|
4112
|
+
:global_cluster_members)
|
4113
|
+
SENSITIVE = []
|
4114
|
+
include Aws::Structure
|
4115
|
+
end
|
4116
|
+
|
4117
|
+
# The `GlobalClusterIdentifier` already exists. Choose a new global
|
4118
|
+
# cluster identifier (unique name) to create a new global cluster.
|
4119
|
+
#
|
4120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/GlobalClusterAlreadyExistsFault AWS API Documentation
|
4121
|
+
#
|
4122
|
+
class GlobalClusterAlreadyExistsFault < Aws::EmptyStructure; end
|
4123
|
+
|
4124
|
+
# A data structure with information about any primary and secondary
|
4125
|
+
# clusters associated with an Amazon DocumentDB global clusters.
|
4126
|
+
#
|
4127
|
+
# @!attribute [rw] db_cluster_arn
|
4128
|
+
# The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
|
4129
|
+
# @return [String]
|
4130
|
+
#
|
4131
|
+
# @!attribute [rw] readers
|
4132
|
+
# The Amazon Resource Name (ARN) for each read-only secondary cluster
|
4133
|
+
# associated with the Aurora global cluster.
|
4134
|
+
# @return [Array<String>]
|
4135
|
+
#
|
4136
|
+
# @!attribute [rw] is_writer
|
4137
|
+
# Specifies whether the Amazon DocumentDB cluster is the primary
|
4138
|
+
# cluster (that is, has read-write capability) for the Amazon
|
4139
|
+
# DocumentDB global cluster with which it is associated.
|
4140
|
+
# @return [Boolean]
|
4141
|
+
#
|
4142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/GlobalClusterMember AWS API Documentation
|
4143
|
+
#
|
4144
|
+
class GlobalClusterMember < Struct.new(
|
4145
|
+
:db_cluster_arn,
|
4146
|
+
:readers,
|
4147
|
+
:is_writer)
|
4148
|
+
SENSITIVE = []
|
4149
|
+
include Aws::Structure
|
4150
|
+
end
|
4151
|
+
|
4152
|
+
# The `GlobalClusterIdentifier` doesn't refer to an existing global
|
4153
|
+
# cluster.
|
4154
|
+
#
|
4155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/GlobalClusterNotFoundFault AWS API Documentation
|
4156
|
+
#
|
4157
|
+
class GlobalClusterNotFoundFault < Aws::EmptyStructure; end
|
4158
|
+
|
4159
|
+
# The number of global clusters for this account is already at the
|
4160
|
+
# maximum allowed.
|
4161
|
+
#
|
4162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/GlobalClusterQuotaExceededFault AWS API Documentation
|
4163
|
+
#
|
4164
|
+
class GlobalClusterQuotaExceededFault < Aws::EmptyStructure; end
|
4165
|
+
|
4166
|
+
# @!attribute [rw] marker
|
4167
|
+
# @return [String]
|
4168
|
+
#
|
4169
|
+
# @!attribute [rw] global_clusters
|
4170
|
+
# @return [Array<Types::GlobalCluster>]
|
4171
|
+
#
|
4172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/GlobalClustersMessage AWS API Documentation
|
4173
|
+
#
|
4174
|
+
class GlobalClustersMessage < Struct.new(
|
4175
|
+
:marker,
|
4176
|
+
:global_clusters)
|
4177
|
+
SENSITIVE = []
|
4178
|
+
include Aws::Structure
|
4179
|
+
end
|
4180
|
+
|
3874
4181
|
# The request would cause you to exceed the allowed number of instances.
|
3875
4182
|
#
|
3876
4183
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InstanceQuotaExceededFault AWS API Documentation
|
@@ -3955,6 +4262,13 @@ module Aws::DocDB
|
|
3955
4262
|
#
|
3956
4263
|
class InvalidEventSubscriptionStateFault < Aws::EmptyStructure; end
|
3957
4264
|
|
4265
|
+
# The requested operation can't be performed while the cluster is in
|
4266
|
+
# this state.
|
4267
|
+
#
|
4268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidGlobalClusterStateFault AWS API Documentation
|
4269
|
+
#
|
4270
|
+
class InvalidGlobalClusterStateFault < Aws::EmptyStructure; end
|
4271
|
+
|
3958
4272
|
# You cannot restore from a virtual private cloud (VPC) backup to a
|
3959
4273
|
# non-VPC DB instance.
|
3960
4274
|
#
|
@@ -3976,7 +4290,7 @@ module Aws::DocDB
|
|
3976
4290
|
#
|
3977
4291
|
class InvalidVPCNetworkStateFault < Aws::EmptyStructure; end
|
3978
4292
|
|
3979
|
-
# An error occurred when accessing an
|
4293
|
+
# An error occurred when accessing an KMS key.
|
3980
4294
|
#
|
3981
4295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/KMSKeyNotAccessibleFault AWS API Documentation
|
3982
4296
|
#
|
@@ -4127,7 +4441,7 @@ module Aws::DocDB
|
|
4127
4441
|
# parameter.
|
4128
4442
|
#
|
4129
4443
|
# The default is a 30-minute window selected at random from an 8-hour
|
4130
|
-
# block of time for each
|
4444
|
+
# block of time for each Region.
|
4131
4445
|
#
|
4132
4446
|
# Constraints:
|
4133
4447
|
#
|
@@ -4147,7 +4461,7 @@ module Aws::DocDB
|
|
4147
4461
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
4148
4462
|
#
|
4149
4463
|
# The default is a 30-minute window selected at random from an 8-hour
|
4150
|
-
# block of time for each
|
4464
|
+
# block of time for each Region, occurring on a random day of the
|
4151
4465
|
# week.
|
4152
4466
|
#
|
4153
4467
|
# Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
@@ -4164,9 +4478,8 @@ module Aws::DocDB
|
|
4164
4478
|
#
|
4165
4479
|
# @!attribute [rw] engine_version
|
4166
4480
|
# The version number of the database engine to which you want to
|
4167
|
-
# upgrade.
|
4168
|
-
#
|
4169
|
-
# `ApplyImmediately` parameter is set to `true`.
|
4481
|
+
# upgrade. Modifying engine version is not supported on Amazon
|
4482
|
+
# DocumentDB.
|
4170
4483
|
# @return [String]
|
4171
4484
|
#
|
4172
4485
|
# @!attribute [rw] deletion_protection
|
@@ -4269,7 +4582,7 @@ module Aws::DocDB
|
|
4269
4582
|
# @!attribute [rw] attribute_name
|
4270
4583
|
# The name of the cluster snapshot attribute to modify.
|
4271
4584
|
#
|
4272
|
-
# To manage authorization for other
|
4585
|
+
# To manage authorization for other accounts to copy or restore a
|
4273
4586
|
# manual cluster snapshot, set this value to `restore`.
|
4274
4587
|
# @return [String]
|
4275
4588
|
#
|
@@ -4277,25 +4590,25 @@ module Aws::DocDB
|
|
4277
4590
|
# A list of cluster snapshot attributes to add to the attribute
|
4278
4591
|
# specified by `AttributeName`.
|
4279
4592
|
#
|
4280
|
-
# To authorize other
|
4281
|
-
# snapshot, set this list to include one or more
|
4282
|
-
#
|
4283
|
-
#
|
4284
|
-
#
|
4285
|
-
#
|
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.
|
4286
4599
|
# @return [Array<String>]
|
4287
4600
|
#
|
4288
4601
|
# @!attribute [rw] values_to_remove
|
4289
4602
|
# A list of cluster snapshot attributes to remove from the attribute
|
4290
4603
|
# specified by `AttributeName`.
|
4291
4604
|
#
|
4292
|
-
# To remove authorization for other
|
4293
|
-
# manual cluster snapshot, set this list to include one or more
|
4294
|
-
# account identifiers. To remove authorization for any
|
4295
|
-
#
|
4296
|
-
#
|
4297
|
-
#
|
4298
|
-
#
|
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.
|
4299
4612
|
# @return [Array<String>]
|
4300
4613
|
#
|
4301
4614
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttributeMessage AWS API Documentation
|
@@ -4350,7 +4663,7 @@ module Aws::DocDB
|
|
4350
4663
|
#
|
4351
4664
|
# @!attribute [rw] db_instance_class
|
4352
4665
|
# The new compute and memory capacity of the instance; for example,
|
4353
|
-
# `db.r5.large`. Not all instance classes are available in all
|
4666
|
+
# `db.r5.large`. Not all instance classes are available in all
|
4354
4667
|
# Regions.
|
4355
4668
|
#
|
4356
4669
|
# If you modify the instance class, an outage occurs during the
|
@@ -4395,13 +4708,9 @@ module Aws::DocDB
|
|
4395
4708
|
# @return [String]
|
4396
4709
|
#
|
4397
4710
|
# @!attribute [rw] auto_minor_version_upgrade
|
4398
|
-
#
|
4399
|
-
#
|
4400
|
-
#
|
4401
|
-
# change is asynchronously applied as soon as possible. An outage
|
4402
|
-
# results if this parameter is set to `true` during the maintenance
|
4403
|
-
# window, and a newer minor version is available, and Amazon
|
4404
|
-
# 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.
|
4405
4714
|
# @return [Boolean]
|
4406
4715
|
#
|
4407
4716
|
# @!attribute [rw] new_db_instance_identifier
|
@@ -4545,7 +4854,7 @@ module Aws::DocDB
|
|
4545
4854
|
# events are returned.
|
4546
4855
|
#
|
4547
4856
|
# Valid values: `db-instance`, `db-parameter-group`,
|
4548
|
-
# `db-security-group
|
4857
|
+
# `db-security-group`
|
4549
4858
|
# @return [String]
|
4550
4859
|
#
|
4551
4860
|
# @!attribute [rw] event_categories
|
@@ -4581,6 +4890,69 @@ module Aws::DocDB
|
|
4581
4890
|
include Aws::Structure
|
4582
4891
|
end
|
4583
4892
|
|
4893
|
+
# Represents the input to ModifyGlobalCluster.
|
4894
|
+
#
|
4895
|
+
# @note When making an API call, you may pass ModifyGlobalClusterMessage
|
4896
|
+
# data as a hash:
|
4897
|
+
#
|
4898
|
+
# {
|
4899
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
4900
|
+
# new_global_cluster_identifier: "GlobalClusterIdentifier",
|
4901
|
+
# deletion_protection: false,
|
4902
|
+
# }
|
4903
|
+
#
|
4904
|
+
# @!attribute [rw] global_cluster_identifier
|
4905
|
+
# The identifier for the global cluster being modified. This parameter
|
4906
|
+
# isn't case-sensitive.
|
4907
|
+
#
|
4908
|
+
# Constraints:
|
4909
|
+
#
|
4910
|
+
# * Must match the identifier of an existing global cluster.
|
4911
|
+
#
|
4912
|
+
# ^
|
4913
|
+
# @return [String]
|
4914
|
+
#
|
4915
|
+
# @!attribute [rw] new_global_cluster_identifier
|
4916
|
+
# The new identifier for a global cluster when you modify a global
|
4917
|
+
# cluster. This value is stored as a lowercase string.
|
4918
|
+
#
|
4919
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
4920
|
+
#
|
4921
|
+
# The first character must be a letter
|
4922
|
+
#
|
4923
|
+
# Can't end with a hyphen or contain two consecutive hyphens
|
4924
|
+
#
|
4925
|
+
# Example: `my-cluster2`
|
4926
|
+
# @return [String]
|
4927
|
+
#
|
4928
|
+
# @!attribute [rw] deletion_protection
|
4929
|
+
# Indicates if the global cluster has deletion protection enabled. The
|
4930
|
+
# global cluster can't be deleted when deletion protection is
|
4931
|
+
# enabled.
|
4932
|
+
# @return [Boolean]
|
4933
|
+
#
|
4934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyGlobalClusterMessage AWS API Documentation
|
4935
|
+
#
|
4936
|
+
class ModifyGlobalClusterMessage < Struct.new(
|
4937
|
+
:global_cluster_identifier,
|
4938
|
+
:new_global_cluster_identifier,
|
4939
|
+
:deletion_protection)
|
4940
|
+
SENSITIVE = []
|
4941
|
+
include Aws::Structure
|
4942
|
+
end
|
4943
|
+
|
4944
|
+
# @!attribute [rw] global_cluster
|
4945
|
+
# A data type representing an Amazon DocumentDB global cluster.
|
4946
|
+
# @return [Types::GlobalCluster]
|
4947
|
+
#
|
4948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyGlobalClusterResult AWS API Documentation
|
4949
|
+
#
|
4950
|
+
class ModifyGlobalClusterResult < Struct.new(
|
4951
|
+
:global_cluster)
|
4952
|
+
SENSITIVE = []
|
4953
|
+
include Aws::Structure
|
4954
|
+
end
|
4955
|
+
|
4584
4956
|
# The options that are available for an instance.
|
4585
4957
|
#
|
4586
4958
|
# @!attribute [rw] engine
|
@@ -4952,6 +5324,47 @@ module Aws::DocDB
|
|
4952
5324
|
include Aws::Structure
|
4953
5325
|
end
|
4954
5326
|
|
5327
|
+
# Represents the input to RemoveFromGlobalCluster.
|
5328
|
+
#
|
5329
|
+
# @note When making an API call, you may pass RemoveFromGlobalClusterMessage
|
5330
|
+
# data as a hash:
|
5331
|
+
#
|
5332
|
+
# {
|
5333
|
+
# global_cluster_identifier: "GlobalClusterIdentifier", # required
|
5334
|
+
# db_cluster_identifier: "String", # required
|
5335
|
+
# }
|
5336
|
+
#
|
5337
|
+
# @!attribute [rw] global_cluster_identifier
|
5338
|
+
# The cluster identifier to detach from the Amazon DocumentDB global
|
5339
|
+
# cluster.
|
5340
|
+
# @return [String]
|
5341
|
+
#
|
5342
|
+
# @!attribute [rw] db_cluster_identifier
|
5343
|
+
# The Amazon Resource Name (ARN) identifying the cluster that was
|
5344
|
+
# detached from the Amazon DocumentDB global cluster.
|
5345
|
+
# @return [String]
|
5346
|
+
#
|
5347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveFromGlobalClusterMessage AWS API Documentation
|
5348
|
+
#
|
5349
|
+
class RemoveFromGlobalClusterMessage < Struct.new(
|
5350
|
+
:global_cluster_identifier,
|
5351
|
+
:db_cluster_identifier)
|
5352
|
+
SENSITIVE = []
|
5353
|
+
include Aws::Structure
|
5354
|
+
end
|
5355
|
+
|
5356
|
+
# @!attribute [rw] global_cluster
|
5357
|
+
# A data type representing an Amazon DocumentDB global cluster.
|
5358
|
+
# @return [Types::GlobalCluster]
|
5359
|
+
#
|
5360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveFromGlobalClusterResult AWS API Documentation
|
5361
|
+
#
|
5362
|
+
class RemoveFromGlobalClusterResult < Struct.new(
|
5363
|
+
:global_cluster)
|
5364
|
+
SENSITIVE = []
|
5365
|
+
include Aws::Structure
|
5366
|
+
end
|
5367
|
+
|
4955
5368
|
# Represents the input to RemoveSourceIdentifierFromSubscription.
|
4956
5369
|
#
|
4957
5370
|
# @note When making an API call, you may pass RemoveSourceIdentifierFromSubscriptionMessage
|
@@ -5198,22 +5611,21 @@ module Aws::DocDB
|
|
5198
5611
|
# @return [Array<Types::Tag>]
|
5199
5612
|
#
|
5200
5613
|
# @!attribute [rw] kms_key_id
|
5201
|
-
# The
|
5202
|
-
#
|
5614
|
+
# The KMS key identifier to use when restoring an encrypted cluster
|
5615
|
+
# from a DB snapshot or cluster snapshot.
|
5203
5616
|
#
|
5204
|
-
# The
|
5205
|
-
#
|
5206
|
-
#
|
5207
|
-
#
|
5208
|
-
#
|
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.
|
5209
5622
|
#
|
5210
5623
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
5211
5624
|
# following occurs:
|
5212
5625
|
#
|
5213
5626
|
# * If the snapshot or cluster snapshot in `SnapshotIdentifier` is
|
5214
|
-
# encrypted, then the restored cluster is encrypted using the
|
5215
|
-
#
|
5216
|
-
# 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.
|
5217
5629
|
#
|
5218
5630
|
# * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is
|
5219
5631
|
# not encrypted, then the restored DB cluster is not encrypted.
|
@@ -5366,26 +5778,26 @@ module Aws::DocDB
|
|
5366
5778
|
# @return [Array<Types::Tag>]
|
5367
5779
|
#
|
5368
5780
|
# @!attribute [rw] kms_key_id
|
5369
|
-
# The
|
5370
|
-
#
|
5781
|
+
# The KMS key identifier to use when restoring an encrypted cluster
|
5782
|
+
# from an encrypted cluster.
|
5371
5783
|
#
|
5372
|
-
# The
|
5373
|
-
#
|
5374
|
-
#
|
5375
|
-
#
|
5376
|
-
#
|
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.
|
5377
5789
|
#
|
5378
5790
|
# You can restore to a new cluster and encrypt the new cluster with an
|
5379
|
-
#
|
5380
|
-
#
|
5381
|
-
#
|
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.
|
5382
5794
|
#
|
5383
5795
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
5384
5796
|
# following occurs:
|
5385
5797
|
#
|
5386
5798
|
# * If the cluster is encrypted, then the restored cluster is
|
5387
|
-
# encrypted using the
|
5388
|
-
#
|
5799
|
+
# encrypted using the KMS key that was used to encrypt the source
|
5800
|
+
# cluster.
|
5389
5801
|
#
|
5390
5802
|
# * If the cluster is not encrypted, then the restored cluster is not
|
5391
5803
|
# encrypted.
|
@@ -5615,19 +6027,19 @@ module Aws::DocDB
|
|
5615
6027
|
#
|
5616
6028
|
# @!attribute [rw] key
|
5617
6029
|
# The required name of the tag. The string value can be from 1 to 128
|
5618
|
-
# Unicode characters in length and can't be prefixed with "aws
|
5619
|
-
# "rds
|
5620
|
-
# digits, white space, '\_', '.', '/', '=', '+',
|
5621
|
-
# 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:
|
5622
6034
|
# "^(\[\\\\p\\\{L\\}\\\\p\\\{Z\\}\\\\p\\\{N\\}\_.:/=+\\\\-\]*)$").
|
5623
6035
|
# @return [String]
|
5624
6036
|
#
|
5625
6037
|
# @!attribute [rw] value
|
5626
6038
|
# The optional value of the tag. The string value can be from 1 to 256
|
5627
|
-
# Unicode characters in length and can't be prefixed with "aws
|
5628
|
-
# "rds
|
5629
|
-
# digits, white space, '\_', '.', '/', '=', '+',
|
5630
|
-
# 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:
|
5631
6043
|
# "^(\[\\\\p\\\{L\\}\\\\p\\\{Z\\}\\\\p\\\{N\\}\_.:/=+\\\\-\]*)$").
|
5632
6044
|
# @return [String]
|
5633
6045
|
#
|